Event Gateway Static Keys

Create a New Static Key

Changed on

Create new static key to this event gateway.

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

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/event-gateways/{gatewayId}/static-keys
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

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

  • 106b373707f3Revision changes
    • breaking

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

    • info

      the request property default value was added

    • info

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

  • 0325d14dfc53Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • warning

      removed subschema #2 from the request body allOf list

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status