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

Example

API Package Operation Response

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

The API Operation identifier.

Example:0f5061ce-78f6-4452-9108-ad7c02821fd6

apiobjectrequiredread-only
* Additional properties are NOT allowed.
Show Child Parameters
methodstringrequiredread-only

The HTTP method of an API Operation.

Allowed values:GETPOSTPUTDELETEPATCHOPTIONSHEADCONNECTTRACE

pathstringrequiredread-only

The path of the API Operation.

Example:/users/{user_id}

rate_limiting_configobjectrequiredread-only

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

* Additional properties are NOT allowed.
Show Child Parameters
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

implementation_statusobject

The implementation status of the operation.

* Additional properties are NOT allowed.
Show Child Parameters
Example

Method

string

The HTTP method of an API Operation.

Allowed values:GETPOSTPUTDELETEPATCHOPTIONSHEADCONNECTTRACE

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

UuidFieldFilter

object

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
eqstring

The field exactly matches the provided value.

Example:?filter[field_name_here][eq]=foo

oeqstring

The field matches any of the provided values.

Example:?filter[field_name_here][oeq]=foo,bar

neqstring

The field does not match the provided value.

Example:?filter[field_name_here][neq]=bar

Example