Get API Version Spec
Returns an API version 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 version specification document.
ApiVersion
Singular version of an API
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The version string of the API version .
Example:v1.0.0
Show Child Parameters
Get Raw API Version Spec
Returns an API version 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 version specification content.
JSON content of the API specification.
List API Docs
Returns a tree view of documents that are associated with an 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
Lists documents for an API.
a document tree
Show Child Parameters
Get API Doc
Returns the specified document from the API’s document tree.
Path Parameters
One OfThe API identifier, either ApiId or Api Slug
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
One OfThe document identifier, either DocumentId or Document Slug
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Headers
Allowed values:text/markdownapplication/jsonapplication/vnd.konnect.document-nodes+json
Default:application/json
Response
application/json
Response
Details for a single document for an API.
ApiDocument
A document for an API. This is a document that is not a part of the API specification.
Unique identifier of the document.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Unique identifier of the parent document.
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
Slug of the document. This is used in the URL to identify the document.
Example:getting-started
Markdown document
Example:# My Kong api This api is powered by Konnect
Title of the document.
Example:Hello World
API Attributes
Endpoints for viewing attributes across APIs published to the portal.