Get Openapi Specification
GET
openapi-spec.yml
The GetAPISpec endpoint provides detailed information about the Vault Data API, including its functionalities, methods, and data structures. The returned data includes a YAML representation of the Vault Data API’s specification, following the OpenAPI Specification (OAS) format.
Resource Information
Method and URI | GET /AutodeskDM/Services/api/vault/v2/openapi-spec.yml |
Authentication Context | No security required |
Required OAuth Scopes | No scopes required |
Data Format | JSON |
Response
HTTP Status Code Summary
200 OK | The request succeeded. The response contains the Vault Data API specification. |
403 Forbidden | Unauthorized |
Response
Body Structure (200)
Response for 200 has no body.
Example
This example illustrates the retrieval of Vault Rest API specification in OpenAPI format.
Note: {VaultServerAddress}
is used as a placeholder in the example(s) and could represent one of the following:
- Vault Server IP address or hostname. Ex: http://10.41.110.49.
- Vault Gateway URL if gateway is configured. Ex: https://test.vg.autodesk.com.
Request
curl -v '{VaultServerAddress}/AutodeskDM/Services/api/vault/v2/openapi-spec.yml' \
-X 'GET' \
-H 'Accept: application/json'
Response
openapi: 3.0.1
info:
title: Vault REST API
description: 'The Vault REST API provides access to the Vault database, offering
a set of endpoints divided into two main sections: Global and Vault. The Global
section includes general operations applicable across the system, while the Vault
section specifically handles interactions with the Vault data. It''s designed
to provide a seamless interface for users to interact with their Vaulted data.'
contact:
name: Vault Data API Feedback
version: 2.0.13
servers:
- url: /AutodeskDM/Services/api/vault/v2
tags:
- name: global
- name: vault
paths:
/openapi-spec.yml:
get:
tags:
- global
summary: Get the complete specification of all APIs
description: This API is essential for developers and users who need detailed
information about the functionalities, methods, and data structures of the
available APIs. The returned data includes a YAML representation of each API's
specification, following the OpenAPI Specification (OAS) format.
operationId: getApiSpec
responses:
'200':
description: ''
content:
application/x-yaml: {}
......
Show More