API Docs
Endpoints for viewing API documentation published to the portal.
List API Specs
DEPRECATEDReturns the API specification documents (OpenAPI or AsyncAPI) attached to the API.
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
List of API specification documents.
Info about an API specification document.
Show Child Parameters
returns the pagination information
Show Child Parameters
Get API Spec
DEPRECATEDReturns an API specification document (OpenAPI or AsyncAPI) for an API.
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Contains a unique identifier for this resource.
Response
application/json
Response
API specification document.
ApiSpecDocument
API specification document.
The type of specification being stored. This allows us to render the specification correctly.
Allowed values:oas2oas3asyncapi
Example:oas3
Get Raw API Spec
DEPRECATEDReturns an API specification content (OpenAPI or AsyncAPI) for an API.
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Contains a unique identifier for this resource.
Response
application/json
Response
API specification content.
List API Versions
Returns the API specification documents (OpenAPI or AsyncAPI) attached to the API.
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
List of API version specification documents.
Summary of an API version.
Show Child Parameters
returns the pagination information