List APIs

Returns a collection of all APIs.

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 APIs 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

Response

application/json

List of APIs

ListApiResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

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

Get an API

Get an API.

get

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Response

application/json

API

API

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

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

namestringrequired

The name of your API. The name + version combination must be unique for each API you publish.

>= 1 characters<= 255 characters

Example:MyAPI

descriptionstring | null

A description of your API. Will be visible on your live Portal.

versionstring | nullrequired

An optional version for your API. Leave this empty if your API is unversioned.

>= 1 characters<= 255 characters

current_version_summaryobject | nullrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
slugstring | nullrequired

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

Match pattern:^[\w-]+$

Example:my-api-v1

api_spec_idsarray[string](uuid)requiredread-onlyDEPRECATED

The id of the API specification.

Example:123e4567-e89b-12d3-a456-426614174000

portalsarray[object]requiredread-onlyunique-items

The list of portals which this API is published to.

Show Child Parameters
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"}

implementation_modestring | nullread-only

the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement

attributesobject

A set of attributes that describe the API

Default:{}

Example:{"env":["production"],"domains":["web","mobile"]}

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

imagesobject | nullread-only

Example:{"icon":{"uri":"/apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw"}}

* Additional properties are NOT allowed.
Show Child Parameters
get/apis/{apiId}
 
application/json

Update API

Updates an API.

patch

Query Parameters

forcestring

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

apiIdstring(uuid)required

The UUID API identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Body

application/json

API

* Additional properties are NOT allowed.
namestring

The name of your API. The name + version combination must be unique for each API you publish.

>= 1 characters<= 255 characters

Example:MyAPI

descriptionstring | null

A description of your API. Will be visible on your live Portal.

versionstring | null

An optional version for your API. Leave this empty if your API is unversioned.

>= 1 characters<= 255 characters

slugstring | null

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

Match pattern:^[\w-]+$

Example:my-api-v1

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

attributesobject

A set of attributes that describe the API

Default:{}

Example:{"env":["production"],"domains":["web","mobile"]}

Response

application/json

API

API

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

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

namestringrequired

The name of your API. The name + version combination must be unique for each API you publish.

>= 1 characters<= 255 characters

Example:MyAPI

descriptionstring | null

A description of your API. Will be visible on your live Portal.

versionstring | nullrequired

An optional version for your API. Leave this empty if your API is unversioned.

>= 1 characters<= 255 characters

current_version_summaryobject | nullrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
slugstring | nullrequired

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

Match pattern:^[\w-]+$

Example:my-api-v1

api_spec_idsarray[string](uuid)requiredread-onlyDEPRECATED

The id of the API specification.

Example:123e4567-e89b-12d3-a456-426614174000

portalsarray[object]requiredread-onlyunique-items

The list of portals which this API is published to.

Show Child Parameters
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"}

implementation_modestring | nullread-only

the implementations that are associated with this api either gateway_entity_binding or access_control_enforcement

attributesobject

A set of attributes that describe the API

Default:{}

Example:{"env":["production"],"domains":["web","mobile"]}

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

imagesobject | nullread-only

Example:{"icon":{"uri":"/apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw"}}

* Additional properties are NOT allowed.
Show Child Parameters
patch/apis/{apiId}

Body

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

List APIs computed

Returns a collection of all APIs with computed fields.

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 APIs 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

Response

application/json

List of APIs with computed fields

List Api Computed Response

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
get/apis/_computed
 
application/json

List API Registrations

Returns a paginated list of registrations for an API.

get

Query Parameters

filterobject

Filters API registrations in the response.

Show Child 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

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Response

application/json

Paginated list of registrations for an API.

ApiRegistrationsListResponse

The response for a list of API registrations.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

An API registration.

* Additional properties are NOT allowed.
Show Child Parameters
get/apis/{apiId}/registrations
 
application/json