Kong · Schema

GatewaySecret

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.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source
View JSON Schema on GitHub

JSON Schema

kong-gatewaysecret-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GatewaySecret",
  "title": "GatewaySecret",
  "description": "A sensitive value containing the secret or a reference to a secret as a template string expression.\nIf the value is provided as plain text, it is encrypted at rest and omitted from API responses.\nIf provided as an expression, the expression itself is stored and returned by the API.\n",
  "type": "string",
  "example": "${vault.env['MY_ENV_VAR']}",
  "minLength": 1,
  "x-expression": {
    "type": "string",
    "fields": [
      "vault"
    ]
  },
  "x-sensitive": true
}