List all Vaults

List all Vaults

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

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

tagsstring

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

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Response

200 application/json

A successful response listing Vaults

dataarray[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.

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

Show Child Parameters
offsetstring

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

get/runtime-groups/{runtimeGroupId}/core-entities/vaults
 
200 application/json

Create a new Vault

Create a new Vault

post

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Body

application/json
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:pre

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

descriptionstring

The description of the Vault object.

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

configobject

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

Show Child Parameters
tagsarray[string]

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

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.

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

post/runtime-groups/{runtimeGroupId}/core-entities/vaults

Body

{ "prefix": "pre", "name": "env", "description": "This vault is used to retrieve redis database access credentials", "config": { "prefix": "SSL_" }, "tags": [ "database-credentials", "data-plane" ] }
 
application/json

Delete a Vault

Delete a Vault

delete

Path Parameters

vault_id_or_prefixstringrequired

ID or prefix of the Vault to delete

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Response

204

Successfully deleted Vault or the resource didn’t exist

delete/runtime-groups/{runtimeGroupId}/core-entities/vaults/{vault_id_or_prefix}
 
204

Get a Vault

Get a Vault using ID or prefix.

Vault entities are used to configure different Vault connectors.

get

Query Parameters

offsetstring

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

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

tagsstring

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

vault_id_or_prefixstringrequired

The unique identifier or the prefix of the Vault to retrieve.

Example:env

runtimeGroupIdstringrequired

The ID of your runtime group. 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.

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

get/runtime-groups/{runtimeGroupId}/core-entities/vaults/{vault_id_or_prefix}
 
application/json

Upsert a Vault

Create or Update Vault using ID or prefix.

put

Path Parameters

vault_id_or_prefixstringrequired

Name or ID of the Vault to lookup

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Body

application/json
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:pre

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

descriptionstring

The description of the Vault object.

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

configobject

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

Show Child Parameters
tagsarray[string]

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

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.

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

put/runtime-groups/{runtimeGroupId}/core-entities/vaults/{vault_id_or_prefix}

Body

{ "prefix": "pre", "name": "env", "description": "This vault is used to retrieve redis database access credentials", "config": { "prefix": "SSL_" }, "tags": [ "database-credentials", "data-plane" ] }
 
application/json