Vault

object

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.

* Additional properties are NOT allowed.
configobject

The configuration properties for the Vault which can be found on the vaults’ documentation page.

* Additional properties are allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

The description of the Vault entity.

idstring

A string representing a UUID (universally unique identifier).

namestringrequired

The name of the Vault that’s going to be added. Currently, the Vault implementation must be installed in every Kong instance.

prefixstringrequired

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.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Example

Error

object

standard error

messagestringread-only

A short summary of the problem.

Example

KonnectCPLegacyUnauthorizedError

messagestringread-only

A short summary of the problem.

Example:Unauthorized

Example

KonnectCPLegacyForbiddenError

messagestringread-only

A short summary of the problem.

Example:Forbidden

Example

KonnectCPLegacyNotFoundError

messagestringread-only

A short summary of the problem.

Example:Not Found

Example