API Products
Create API Product
An API Product packages together associated APIs and their operations, backed by thorough documentation,
with the objective of making API consumption straightforward for developers.
Body
application/json
Body
Create API Product Request
The request schema to create an API product.
The name of the API product.
>= 1 characters<= 100 characters
Example:API Product
The description of the API product.
Default:null
Example:Text describing the API product
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"}
Public labels store information about an entity that can be used for filtering a list of objects.
Public labels are intended to store PUBLIC metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"category":"finance"}
The list of portal identifiers which this API product should be published to
>= 0 items
Response
application/json
Response
API product
API Product
The API product ID.
Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8
The name of the API product
Example:My Name
The description of the API product
Example:MyDescription
The list of portal identifiers which this API product is published to.
This property is deprecated and will be removed in a future version. Use the portals property instead.
>= 0 items
The list of portals which this API product is published to
>= 0 items
Show Child Parameters
The number of product versions attached to this API product
Example:10
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
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"}
Public labels store information about an entity that can be used for filtering a list of objects.
Public labels are intended to store PUBLIC metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"category":"finance"}
Authentication
Body
List API Products
Returns a collection of API products.
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 API Products 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
Filters requested resource by associated labels.
Example:key:value,keyExists
Filters requested resource by associated public labels.
Example:key:value,keyExists
Response
application/json
Response
List of API products
ListAPIProductsResponse
returns the pagination information
Show Child Parameters
Show Child Parameters
Authentication
Query Parameters
Get an API product
Returns an API product.
Path Parameters
API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
API product
API Product
The API product ID.
Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8
The name of the API product
Example:My Name
The description of the API product
Example:MyDescription
The list of portal identifiers which this API product is published to.
This property is deprecated and will be removed in a future version. Use the portals property instead.
>= 0 items
The list of portals which this API product is published to
>= 0 items
Show Child Parameters
The number of product versions attached to this API product
Example:10
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
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"}
Public labels store information about an entity that can be used for filtering a list of objects.
Public labels are intended to store PUBLIC metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"category":"finance"}
Authentication
Path Parameters
Update an individual API product
Updates an API product.
Path Parameters
API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
Update API Product Request
The request schema for updating an API product.
The name for the API product.
>= 1 characters<= 100 characters
Example:API Product
The description of the API product.
Example:Text describing the API product
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"}
Public labels store information about an entity that can be used for filtering a list of objects.
Public labels are intended to store PUBLIC metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"category":"finance"}
The list of portal identifiers which this API product should be published to
>= 0 items
Response
application/json
Response
API product
API Product
The API product ID.
Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8
The name of the API product
Example:My Name
The description of the API product
Example:MyDescription
The list of portal identifiers which this API product is published to.
This property is deprecated and will be removed in a future version. Use the portals property instead.
>= 0 items
The list of portals which this API product is published to
>= 0 items
Show Child Parameters
The number of product versions attached to this API product
Example:10
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
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"}
Public labels store information about an entity that can be used for filtering a list of objects.
Public labels are intended to store PUBLIC metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"category":"finance"}