Vaults

Get a Vault

Changed on

Get a Vault using ID or prefix.

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

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/vaults/{VaultId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Response

Successfully fetched Vault

configobject nullable

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

created_atinteger nullable

Unix epoch when the resource was created.

descriptionstring nullable

The description of the Vault entity.

idstring nullable

A string representing a UUID (universally unique identifier).

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[] nullable

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

updated_atinteger nullable

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

  • 76b0fefddb0dRevision changes
    • breaking

      the response property became nullable for the status

  • 0aead68de7b0Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status