Sign in
Event Gateway Static Keys

Get a Static Key

Returns information about an individual static key.

get/v1/event-gateways/{gatewayId}/static-keys/{staticKeyId}

Response

A single static key.

namestring required

The unique name of the static key.

descriptionstring

A human-readable description of the static key.

labelsLabels

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 "_".

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.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "labels": {
    "env": "test"
  },
  "value": "${vault.env['MY_ENV_VAR']}",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 2 of the 75 revisions of this API.2