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.
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.
Query Parameters
Filters API attributes in the response.
Show Child Parameters
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
Response
Paginated list of attributes across all APIs published in this portal.
ListApiAttributesPage
returns the pagination information
Show Child Parameters
Show Child Parameters
ApiSlug
stringThe Api slug is used in generated URLs to provide human readable paths.
Defaults to slugify(name + version)
Match pattern:^[\w-]+$
ApiId
stringThe API identifier.