EventGatewayStaticKey

object

A symmetric key with its secret value.

namestringrequired

The unique name of the static key.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the static key.

Default:

<= 512 characters

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

idstring(uuid)required

The unique identifier of the static key.

valuestring

A sensitive value containing the secret or a reference to a secret as a template string expression.
If the value is provided as plain text, it is encrypted at rest and omitted from API responses.
If provided as an expression, the expression itself is stored and returned by the API.

>= 1 characters

Example:${vault.env['MY_ENV_VAR']}

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

EventGatewayStaticKeyCreate

object

A symmetric key with its secret value for creation.

namestringrequired

The unique name of the static key.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the static key.

Default:

<= 512 characters

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

valuestringrequired

A sensitive value containing the secret or a reference to a secret as a template string expression.
If the value is provided as plain text, it is encrypted at rest and omitted from API responses.
If provided as an expression, the expression itself is stored and returned by the API.

>= 1 characters

Example:${vault.env['MY_ENV_VAR']}

Example

EventGatewayPolicyReference

string

The unique identifier of the policy.

CursorMetaPage

object
firststring(path)

URI to the first page

laststring(path)

URI to the last page

nextstring(path)required

URI to the next page

previousstring(path)required

URI to the previous page

sizenumberrequired

Requested page size

Example:10

Example

CursorMeta

object

Pagination metadata.

pageobjectrequired
Show Child Parameters
Example