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 3 of the 29 revisions of this API.110

  • 106b373707f31See the full diff
    • ○

      the description response's property default value was added for the status 200

      response-property-default-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0325d14dfc5318See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      removed BaseEventGatewayStaticKey subschema #2 from the response body allOf list for the response status 200

      response-body-all-of-removed

    • ○

      added the optional property description to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property labels to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property value to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property created_at to the response with the 200 status

      response-required-property-added

    • ○

      added the required property id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property name to the response with the 200 status

      response-required-property-added

    • ○

      added the required property updated_at to the response with the 200 status

      response-required-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5d2b35832e3f1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 57 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog