Get an API
Get an API.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
API
API
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The name of your API. The name + version combination must be unique for each API you publish.
>= 1 characters<= 255 characters
Example:MyAPI
A description of your API. Will be visible on your live Portal.
An optional version for your API. Leave this empty if your API is unversioned.
>= 1 characters<= 255 characters
Show Child Parameters
The slug is used in generated URLs to provide human readable paths.
Defaults to slugify(name + version)
Match pattern:^[\w-]+$
Example:my-api-v1
The id of the API specification.
Example:123e4567-e89b-12d3-a456-426614174000
The list of portals which this API is published to.
Show Child Parameters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement
A set of attributes that describe the API
Default:{}
Example:{"env":["production"],"domains":["web","mobile"]}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update API
Updates an API.
Query Parameters
If true, allows operations to be removed from the current version when using access control enforcement.
If false, operations removal will be rejected with a 409 error.
Omitting the value means true.
Allowed values:truefalse
Default:false
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
API
The name of your API. The name + version combination must be unique for each API you publish.
>= 1 characters<= 255 characters
Example:MyAPI
A description of your API. Will be visible on your live Portal.
An optional version for your API. Leave this empty if your API is unversioned.
>= 1 characters<= 255 characters
The slug is used in generated URLs to provide human readable paths.
Defaults to slugify(name + version)
Match pattern:^[\w-]+$
Example:my-api-v1
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Labels are intended to store INTERNAL metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
A set of attributes that describe the API
Default:{}
Example:{"env":["production"],"domains":["web","mobile"]}
Response
application/json
Response
API
API
The API identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The name of your API. The name + version combination must be unique for each API you publish.
>= 1 characters<= 255 characters
Example:MyAPI
A description of your API. Will be visible on your live Portal.
An optional version for your API. Leave this empty if your API is unversioned.
>= 1 characters<= 255 characters
Show Child Parameters
The slug is used in generated URLs to provide human readable paths.
Defaults to slugify(name + version)
Match pattern:^[\w-]+$
Example:my-api-v1
The id of the API specification.
Example:123e4567-e89b-12d3-a456-426614174000
The list of portals which this API is published to.
Show Child Parameters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement
A set of attributes that describe the API
Default:{}
Example:{"env":["production"],"domains":["web","mobile"]}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Query Parameters
Body
Delete API
Deletes an API.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
Response
API was deleted successfully.
Authentication
Path Parameters
API Documentation
Create API Document
Publish a new document attached to an API.
All configuration options may be provided in the frontmatter section of content. If you set values in both the POST request and in the frontmatter, the values in the POST request will take precedence.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
API Document
Raw markdown content to display in your Portal
The title of the document. Used to populate the <title> tag for the page
Example:API Document
The slug is used in generated URLs to provide human readable paths.
Defaults to slugify(title)
Match pattern:^[\w-]+$
Example:api-document
If status=published the document will be visible in your live portal
Allowed values:publishedunpublished
Default:unpublished
API Documents may be rendered as a tree of files.
Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.
Example:null
Response
application/json
Response
API document
API Document
The API document identifier.
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
Raw markdown content to display in your Portal
The title of the document. Used to populate the <title> tag for the page
Example:API Document
The slug is used in generated URLs to provide human readable paths.
Defaults to slugify(title)
Match pattern:^[\w-]+$
Example:api-document
If status=published the document will be visible in your live portal
Allowed values:publishedunpublished
Default:unpublished
API Documents may be rendered as a tree of files.
Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.
Example:null
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z