Event Gateway Static Keys

Static Keys are used by the Encrypt and Decrypt policies to encrypt data at rest

List Event Gateway Static Keys

Returns a list of static keys associated to this event gateway.

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[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter documents returned in the response.

Show Child Parameters

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

A paginated list response for a collection of static keys.

metaobject

Pagination metadata.

Show Child Parameters
dataarray[object]

A symmetric key with its secret value.

Show Child Parameters
get/event-gateways/{gatewayId}/static-keys
 
application/json

Create a New Static Key

Create new static key to this event gateway.

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

The request schema for creating a static key.

EventGatewayStaticKeyCreate

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']}

Response

application/json

Created

EventGatewayStaticKey

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

post/event-gateways/{gatewayId}/static-keys

Body

{ "name": "name", "value": "${vault.env['MY_ENV_VAR']}" }
 
application/json

Get a Static Key

Returns information about an individual static key.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

staticKeyIdstring(uuid)required

The ID of the static key.

Response

application/json

A single static key.

EventGatewayStaticKey

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

get/event-gateways/{gatewayId}/static-keys/{staticKeyId}
 
application/json

Delete Event Gateway Static Key

Deletes a specific static key associated with the Event Gateway.

delete

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

staticKeyIdstring(uuid)required

The ID of the static key.

Response

No Content

delete/event-gateways/{gatewayId}/static-keys/{staticKeyId}