API Package

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

The API Package identifier.

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

namestringrequired

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

>= 1 characters<= 255 characters

Example:MyAPIPackage

descriptionstring

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

slugstringrequired

The unique slug for your API Package, It should be unique across all APIs and API Packages.

Match pattern:^[\w-]+$

Example:my-api-package-v1

versionstringrequired

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

>= 1 characters<= 255 characters

rate_limiting_configobjectrequired

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* Additional properties are NOT allowed.
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"}

attributesobjectrequired

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

imagesobjectread-only

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

* Additional properties are NOT allowed.
Show Child Parameters
Example

Rate Limiting configuration

object

Rate limit configuration that can be applied to an API Package or an API Package Operation.

* Additional properties are NOT allowed.
limitintegerrequired

The amount of requests allowed for each operation within the specified duration.

>= 0

durationstringrequired

The timeframe to ensure that an application does not exceed the request limit.

Allowed values:secondsminuteshours

Example

Image Status

object
* Additional properties are NOT allowed.
errorstringrequiredread-only

An error related to the image invalid status.

statusstringrequiredread-only

The status of the image.

Allowed values:uploadingvalidatingvalidinvalid

Example:valid

api_package_idstring(uuid)requiredread-only

The API identifier which the image belongs to.

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

image_typestringrequiredread-only

The type of the image.

Allowed values:icon

Example:icon

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

Example

ApiRegistrationsListResponse

object

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
Example

ApiRegistration

object

An API registration.

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

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

statusstringrequired

Allowed values:approvedpendingrejectedrevoked

portalobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
applicationobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example