Sign in
Event Gateway Static Keys

Create a New Static Key

Create new static key to this event gateway.

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

Request body

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

valuestring required

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.

Example request

{
  "labels": {
    "env": "test"
  },
  "value": "${vault.env['MY_ENV_VAR']}"
}

Response

Created

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 30 revisions of this API.5113

  • 106b373707f312See the full diff
    • ▲

      the value request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ○

      the description request property default value was added

      request-property-default-value-added

    • ○

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

      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

  • 0325d14dfc534110See the full diff
    • ▲

      added the new required request property name

      new-required-request-property

    • ▲

      added the new required request property value

      new-required-request-property

    • ▲

      the request's body type/format changed from / to object/

      request-body-type-changed

    • ▲

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

      response-body-type-changed

    • ●

      removed BaseEventGatewayStaticKey subschema #2 from the request body allOf list

      request-body-all-of-removed

    • ○

      added the new optional request property description

      new-optional-request-property

    • ○

      added the new optional request property labels

      new-optional-request-property

    • ○

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

      response-body-all-of-removed

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

      added the required property updated_at to the response with the 201 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