Create a new Vault

Create a new Vault

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

Description of the new Vault for creation

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.

* 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.

Response

application/json

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.

* 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.

post/control-planes/{controlPlaneId}/core-entities/vaults

Body

{ "config": { "prefix": "ENV_PREFIX" }, "description": "environment variable based vault", "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8", "name": "env", "prefix": "env", "tags": [ "foo", "bar" ] }
 
application/json

Delete a Vault

Delete a Vault

delete

Path Parameters

VaultIdstringrequired

ID of the Vault to lookup

Example:9d4d6d19-77c6-428e-a965-9bc9647633e9

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

Successfully deleted Vault or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/vaults/{VaultId}
 

Get a Vault

Get a Vault using ID or prefix.

get

Path Parameters

VaultIdstringrequired

ID of the Vault to lookup

Example:9d4d6d19-77c6-428e-a965-9bc9647633e9

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

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.

* 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.

get/control-planes/{controlPlaneId}/core-entities/vaults/{VaultId}
 
application/json

Upsert a Vault

Create or Update Vault using ID or prefix.

put

Path Parameters

VaultIdstringrequired

ID of the Vault to lookup

Example:9d4d6d19-77c6-428e-a965-9bc9647633e9

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

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.

* 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.

Response

application/json

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.

* 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.

put/control-planes/{controlPlaneId}/core-entities/vaults/{VaultId}

Body

{ "config": { "prefix": "ENV_PREFIX" }, "description": "environment variable based vault", "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8", "name": "env", "prefix": "env", "tags": [ "foo", "bar" ] }
 
application/json

DataPlaneClientCertificate

object
idstring

Unique ID of the certificate entity.

created_atinteger

Date certificate was created.

updated_atinteger

Date certificate was last updated.

certstring

JSON escaped string of the certificate.

Example