You are browsing documentation for an older version. See the latest documentation here.

Reference Format

We use the URL syntax to describe references to a secret store.

{vault://<vault-backend|entity>/<secret-id>[/<secret-key][?query]}

{vault://<vault-backend|entity>/<secret-id>[/<secret-key]}
 ^^^^^

The vault in the URL is used as an identifier for Kong. We use this to reference a vault.

{vault://<vault-prefix>/<secret-id>[/<secret-key]}
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The path of the URL defines the following:

The prefix for a vault can be either the name of the backend or the name of vault entity that you created.

Examples:

{vault://env/<secret-id>[/<secret-key]}
         ^^^

or using a vault entity

{vault://my-env-vault/<secret-id>[/<secret-key]}
         ^^^^^^^^^^^^

The secret-id is used as an identifier in case the vault uses a nested data structure.

The secret-key is used to identify the secret within the secret-id object.

Query arguments are used to denote configuration options in a key=value format to the Vault Prefix