Get API Version Spec

Returns an API version specification document (OpenAPI or AsyncAPI) for an API.

get
/api/v3/apis/{apiIdOrSlug}/versions/{versionId}

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

versionIdstring(uuid)required

Contains a unique identifier for this resource.

Response

application/json

API version specification document.

ApiVersion

Singular version of an API

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

versionstringrequired

The version string of the API version .

Example:v1.0.0

specobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
application/json

Get Raw API Version Spec

Returns an API version specification content (OpenAPI or AsyncAPI) for an API.

get
/api/v3/apis/{apiIdOrSlug}/versions/{versionId}/raw

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

versionIdstring(uuid)required

Contains a unique identifier for this resource.

Response

application/json

API version specification content.

object

JSON content of the API specification.

application/json

List API Docs

Returns a tree view of documents that are associated with an API.

get
/api/v3/apis/{apiIdOrSlug}/documents

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Response

application/json

Lists documents for an API.

dataarray[object]required

a document tree

* Additional properties are NOT allowed.
Show Child Parameters
application/json

Get API Doc

Returns the specified document from the API’s document tree.

get
/api/v3/apis/{apiIdOrSlug}/documents/{documentIdOrSlug}

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

documentIdOrSlugOne Of
required

The document identifier, either DocumentId or Document Slug

DocumentIdstring(uuid)

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Headers

Acceptstring

Allowed values:text/markdownapplication/jsonapplication/vnd.konnect.document-nodes+json

Default:application/json

Response

application/json

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.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Unique identifier of the document.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

parent_document_idstring | null(uuid)

Unique identifier of the parent document.

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

slugstringrequired

Slug of the document. This is used in the URL to identify the document.

Example:getting-started

contentstringrequired

Markdown document

Example:# My Kong api This api is powered by Konnect

titlestringrequired

Title of the document.

Example:Hello World

application/json

API Attributes

Endpoints for viewing attributes across APIs published to the portal.