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).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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
Create or update a node
Create or update a node.
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Node identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
Upsert Node Request
The request schema to upsert a Node.
Example:node1.my.domain.com
Example:knep
Example:1.0
Show Child Parameters
Response
application/json
Response
Example response
Show Child Parameters
Authentication
Path Parameters
Body
Create or Update the declarative config
Create or Update the declarative config
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
DeclarativeConfig
The configuration as string. Must be valid yaml or json.
Response
application/json
Response
Declarative Config Response
DeclarativeConfig
The configuration as string. Must be valid yaml or json.
An uuid identifier (v7) of the version of the config payload.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
Authentication
Path Parameters
Body
Get the declarative configuration
Returns the declarative configuration set for the control plane.
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
Declarative Config Response
DeclarativeConfig
The configuration as string. Must be valid yaml or json.
An uuid identifier (v7) of the version of the config payload.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
Authentication
Path Parameters
Delete the declarative config
Delete the declarative config
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
The configuration was deleted successfully.