Kong · Schema

Vault

Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, Hashicorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
config	object	The configuration properties for the Vault which can be found on the vaults' documentation page.
created_at	integer	Unix epoch when the resource was created.
description	string	The description of the Vault entity.
id	string	A string representing a UUID (universally unique identifier).
name	string	The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
prefix	string	The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
tags	array	An optional set of strings associated with the Vault for grouping and filtering.
updated_at	integer	Unix epoch when the resource was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Vault",
  "title": "Vault",
  "x-speakeasy-entity": "Vault",
  "description": "Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, Hashicorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.",
  "type": "object",
  "properties": {
    "config": {
      "description": "The configuration properties for the Vault which can be found on the vaults' documentation page.",
      "type": "object",
      "additionalProperties": true,
      "nullable": true
    },
    "created_at": {
      "description": "Unix epoch when the resource was created.",
      "type": "integer",
      "nullable": true
    },
    "description": {
      "description": "The description of the Vault entity.",
      "type": "string",
      "nullable": true
    },
    "id": {
      "description": "A string representing a UUID (universally unique identifier).",
      "type": "string",
      "nullable": true
    },
    "name": {
      "description": "The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.",
      "type": "string"
    },
    "prefix": {
      "description": "The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.",
      "type": "string"
    },
    "tags": {
      "description": "An optional set of strings associated with the Vault for grouping and filtering.",
      "type": "array",
      "items": {
        "description": "A string representing a tag.",
        "type": "string"
      },
      "nullable": true
    },
    "updated_at": {
      "description": "Unix epoch when the resource was last updated.",
      "type": "integer",
      "nullable": true
    }
  },
  "example": {
    "config": {
      "prefix": "ENV_PREFIX"
    },
    "description": "environment variable based vault",
    "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8",
    "name": "env",
    "prefix": "env",
    "tags": [
      "foo",
      "bar"
    ]
  },
  "additionalProperties": false,
  "required": [
    "name",
    "prefix"
  ]
}