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.

configobject

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

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

descriptionstring

The description of the Vault entity.

Example:This vault is used to retrieve redis database access credentials

idstring

Example:B2A30E8F-C542-49CF-8015-FB674987D1A5

namestring

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

Example:env

prefixstring

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.

Example:env

tagsarray[string]

An optional set of strings associated with the Vault for grouping and filtering.

Example:database-credentials

updated_atinteger

Unix epoch when the resource was last updated.

Example:1422386534

Example

pagination-offset-response

string

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example

InvalidRules

string

invalid parameters rules

Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype

InvalidParameterStandard

object
* Additional properties are NOT allowed.
fieldstringrequiredread-only

Example:name

rulestringread-only

invalid parameters rules

Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype

sourcestring

Example:body

reasonstringrequiredread-only

Example:is a required field

Example