Home / Event Gateway / Kong Event Gateway entities
Edit
Report

Static keys

Uses: Event Gateway Konnect API
Related Documentation
Event Gateway Documentation
OpenAPI Specifications
Konnect Event Gateway
Incompatible with
on-prem
Related Resources
Encrypt policy
Decrypt policy
Encrypt and decrypt Kafka messages with Kong Event Gateway

Static keys

Static keys are resources that you can use in the Encrypt and Decrypt policies to encrypt and decrypt messages.

A static key can contain a secret (Base64-encoded key) 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, e.g. ${vault.env["MY_ENV_VAR"]}.

Set up a static key 

curl -X POST https://{region}.api.konghq.com/v1/event-gateways/{eventGatewayId}/static-keys \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "my-key",
      "value": "'$MY_KEY'"
    }
    '

Make sure to replace the following placeholders with your own values:

  • region: Geographic region where your Kong Konnect is hosted and operates.

  • KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

  • virtualClusterId: The id of the Virtual Cluster.

  • eventGatewayId: The id of the Event Gateway.

  • eventGatewayListenerId: The id of the Event Gateway Listener.

See the Konnect Event Gateway API reference to learn about region-specific URLs and personal access tokens.

Schema

Something wrong?
Report an Issue | Edit this Page

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!
Contribute

Still need help

Ask in our Forum
Contact Support