Vaults
Vaults
List all Vaults
List all Vaults
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources
A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.
Example:tag1,tag2
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
A successful response listing Vaults
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.
Example:{"config":{"prefix":"ENV_PREFIX"},"description":"environment variable based vault","id":"2747d1e5-8246-4f65-a939-b392f1ee17f8","name":"env","tags":["foo","bar"]}
Show Child Parameters
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Authentication
Path Parameters
Query Parameters
Create a new Vault
Create a new Vault
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
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:pre
The name of the Vault that’s going to be added. Currently, the Vault implementation must be installed in every Kong instance.
Example:env
The description of the Vault object.
Example:This vault is used to retrieve redis database access credentials
The configuration properties for the Vault which can be found on the vaults’ documentation page.
Show Child Parameters
An optional set of strings associated with the Vault for grouping and filtering.
Response
application/json
Response
Successfully created Vault
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.
The configuration properties for the Vault which can be found on the vaults’ documentation page.
Unix epoch when the resource was created.
Example:1422386534
The description of the Vault entity.
Example:This vault is used to retrieve redis database access credentials
Example:B2A30E8F-C542-49CF-8015-FB674987D1A5
The name of the Vault that’s going to be added. Currently, the Vault implementation must be installed in every Kong instance.
Example:env
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
An optional set of strings associated with the Vault for grouping and filtering.
Example:database-credentials
Unix epoch when the resource was last updated.
Example:1422386534
Authentication
Path Parameters
Body
Delete a Vault
Delete a Vault
Path Parameters
ID or prefix of the Vault to delete
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
204
Response
Successfully deleted Vault or the resource didn’t exist
Authentication
Path Parameters
Get a Vault
Get a Vault using ID or prefix.
Vault entities are used to configure different Vault connectors.
Query Parameters
Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources
Number of resources to be returned.
Default:100
>= 1<= 1000
A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.
Example:tag1,tag2
Path Parameters
The unique identifier or the prefix of the Vault to retrieve.
Example:env
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
Successfully fetched Vault
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.
The configuration properties for the Vault which can be found on the vaults’ documentation page.
Unix epoch when the resource was created.
Example:1422386534
The description of the Vault entity.
Example:This vault is used to retrieve redis database access credentials
Example:B2A30E8F-C542-49CF-8015-FB674987D1A5
The name of the Vault that’s going to be added. Currently, the Vault implementation must be installed in every Kong instance.
Example:env
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
An optional set of strings associated with the Vault for grouping and filtering.
Example:database-credentials
Unix epoch when the resource was last updated.
Example:1422386534