Get a Vault
Get a Vault using ID or prefix.
Path Parameters
ID of the Vault to lookup
Example:9d4d6d19-77c6-428e-a965-9bc9647633e9
The UUID of your control plane. 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.
The description of the Vault entity.
A string representing a UUID (universally unique identifier).
The name of the Vault that’s going to be added. Currently, the Vault implementation must be installed in every Kong instance.
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.
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Upsert a Vault
Create or Update Vault using ID or prefix.
Path Parameters
ID of the Vault to lookup
Example:9d4d6d19-77c6-428e-a965-9bc9647633e9
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the 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.
The description of the Vault entity.
A string representing a UUID (universally unique identifier).
The name of the Vault that’s going to be added. Currently, the Vault implementation must be installed in every Kong instance.
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.
A string representing a tag.
Unix epoch when the resource was last updated.
Response
application/json
Response
Successfully upserted 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.
The description of the Vault entity.
A string representing a UUID (universally unique identifier).
The name of the Vault that’s going to be added. Currently, the Vault implementation must be installed in every Kong instance.
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.
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
DataPlaneClientCertificate
objectUnique ID of the certificate entity.
Date certificate was created.
Date certificate was last updated.
JSON escaped string of the certificate.
ConfigStore
objectThe Config Store ID.
Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8
The name of the Config Store
Example:My Name
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Create Config Store Request
objectThe request schema to create a Config Store.
>= 1 characters<= 100 characters
Example:Config Store