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.

post

Body

application/json

Create API Product Request

The request schema to create an API product.

* Additional properties are NOT allowed.
namestringrequired

The name of the API product.

>= 1 characters<= 100 characters

Example:API Product

descriptionstring | null

The description of the API product.

Default:null

Example:Text describing the API product

labelsobject

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_labelsobject

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"}

portal_idsarray[string](uuid)unique-items

The list of portal identifiers which this API product should be published to

>= 0 items

Response

application/json

API product

API Product

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API product ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

The name of the API product

Example:My Name

descriptionstring | nullrequired

The description of the API product

Example:MyDescription

portal_idsarray[string](uuid)requiredunique-itemsDEPRECATED

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

portalsarray[object]required

The list of portals which this API product is published to

>= 0 items

* Additional properties are NOT allowed.
Show Child Parameters
version_countnumberrequired

The number of product versions attached to this API product

Example:10

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

labelsobjectrequired

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_labelsobjectrequired

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"}

post/api-products

Body

{ "name": "API Product" }
 
application/json

List API Products

Returns a collection of API products.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters API Products in the response.

Show Child Parameters
sortstring

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

labelsstring

Filters requested resource by associated labels.

Example:key:value,keyExists

public_labelsstring

Filters requested resource by associated public labels.

Example:key:value,keyExists

Response

application/json

List of API products

ListAPIProductsResponse

metaobjectrequired

returns the pagination information

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

Get an API product

Returns an API product.

get

Path Parameters

idstring(uuid)required

API product identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

API product

API Product

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API product ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

The name of the API product

Example:My Name

descriptionstring | nullrequired

The description of the API product

Example:MyDescription

portal_idsarray[string](uuid)requiredunique-itemsDEPRECATED

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

portalsarray[object]required

The list of portals which this API product is published to

>= 0 items

* Additional properties are NOT allowed.
Show Child Parameters
version_countnumberrequired

The number of product versions attached to this API product

Example:10

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

labelsobjectrequired

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_labelsobjectrequired

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"}

get/api-products/{id}
 
application/json

Update an individual API product

Updates an API product.

patch

Path Parameters

idstring(uuid)required

API product identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Update API Product Request

The request schema for updating an API product.

* Additional properties are NOT allowed.
namestring

The name for the API product.

>= 1 characters<= 100 characters

Example:API Product

descriptionstring | null

The description of the API product.

Example:Text describing the API product

labelsobject | null

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_labelsobject

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"}

portal_idsarray[string](uuid)unique-items

The list of portal identifiers which this API product should be published to

>= 0 items

Response

application/json

API product

API Product

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API product ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

The name of the API product

Example:My Name

descriptionstring | nullrequired

The description of the API product

Example:MyDescription

portal_idsarray[string](uuid)requiredunique-itemsDEPRECATED

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

portalsarray[object]required

The list of portals which this API product is published to

>= 0 items

* Additional properties are NOT allowed.
Show Child Parameters
version_countnumberrequired

The number of product versions attached to this API product

Example:10

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

labelsobjectrequired

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_labelsobjectrequired

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"}

patch/api-products/{id}

Body

{ "name": "API Product with Update Name", "description": "Updated text describing the API product" }
 
application/json