Sign in
Vaults

Update a Vault

Update a Vault

patch/vaults/{VaultIdOrPrefix}

Request body

configobject required

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

created_atinteger

Unix epoch when the resource was created.

descriptionstring nullable

The description of the Vault entity.

idstring nullable
namestring required

The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.

prefixstring required

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.

tagsstring[]

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

updated_atinteger

Unix epoch when the resource was last updated.

Example request

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

Response

Successfully updated Vault

configobject required

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

created_atinteger

Unix epoch when the resource was created.

descriptionstring nullable

The description of the Vault entity.

idstring nullable
namestring required

The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.

prefixstring required

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.

tagsstring[]

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

updated_atinteger

Unix epoch when the resource was last updated.

Example response

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

Changes