List Event Gateway Static Keys
Returns a list of static keys associated to this event gateway.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Filter documents returned in the response.
Show Child Parameters
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A paginated list response for a collection of static keys.
Pagination metadata.
Show Child Parameters
A symmetric key with its secret value.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create a New Static Key
Create new static key to this event gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The request schema for creating a static key.
EventGatewayStaticKeyCreate
A symmetric key with its secret value for creation.
The unique name of the static key.
>= 1 characters<= 255 characters
A human-readable description of the static key.
Default:
<= 512 characters
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"}
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
Response
Created
EventGatewayStaticKey
A symmetric key with its secret value.
The unique name of the static key.
>= 1 characters<= 255 characters
A human-readable description of the static key.
Default:
<= 512 characters
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"}
The unique identifier of the static key.
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']}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Get a Static Key
Returns information about an individual static key.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the static key.
Response
application/json
Response
A single static key.
EventGatewayStaticKey
A symmetric key with its secret value.
The unique name of the static key.
>= 1 characters<= 255 characters
A human-readable description of the static key.
Default:
<= 512 characters
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"}
The unique identifier of the static key.
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']}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Delete Event Gateway Static Key
Deletes a specific static key associated with the Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the static key.
Response
Response
No Content
Authentication
Path Parameters
Event Gateway Schema Registries
Configure a schema registry that can be used to validate payloads when producing/consuming messages