API
Create API
Creates an API.
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.
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"]}
The content of the API specification. This is the raw content of the API specification, in json or yaml. By including this field, you can add a API specification without having to make a separate call to update the API specification.
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
Body
List APIs
Returns a collection of all APIs.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters APIs in the response.
Show Child Parameters
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Response
application/json
Response
List of APIs
ListApiResponse
returns the pagination information
Show Child Parameters
Show Child Parameters
Authentication
Query Parameters
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