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.

List API Attributes

Get a paginated list of all attributes across APIs in the portal.
If authenticated, results will include attributes of APIs visible to the authenticated user.
If not authenticated, results will include only attributes of publicly visible APIs.

When the selected query parameter is provided, the response will include a selected_api_count
field for each attribute value, indicating how many APIs would match that attribute value
when combined with the currently selected filters.

get
/api/v3/api-attributes

Query Parameters

filterobject

Filters API attributes in the response.

Show Child Parameters
selectedobject

Specifies selected attribute values to calculate filtered API counts.
Use the format: selected[<attribute_key>]=<attribute_value_1>,<attribute_value_2>
When provided, the response will include selected_api_count for each attribute value.

Example:{"domain":"airlines,flights","visibility":"external"}

Response

application/json

Paginated list of attributes across all APIs published in this portal.

ListApiAttributesPage

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
application/json