Sign in
Vaults

Create a new Vault

Create a new Vault

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

Request body

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 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 created 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

Changed in 5 of the 52 revisions of this API.1418

  • 2c77aeaee5fb11See the full diff
    • ▲

      the response property tags became nullable for the status 201

      response-property-became-nullable

    • ○

      the request property tags became nullable

      request-property-became-nullable

  • 60ce7598bbd022See the full diff
    • ▲

      the response property config became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property config became optional for the status 201

      response-property-became-optional

    • ○

      the request property config became nullable

      request-property-became-nullable

    • ○

      the request property config became optional

      request-property-became-optional

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fc6abbc537f326See the full diff
    • ▲

      the response property created_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property updated_at became nullable for the status 201

      response-property-became-nullable

    • ○

      the request optional property created_at became not read-only

      request-optional-property-became-not-read-only

    • ○

      the request optional property updated_at became not read-only

      request-optional-property-became-not-read-only

    • ○

      the request property created_at became nullable

      request-property-became-nullable

    • ○

      the request property updated_at became nullable

      request-property-became-nullable

    • ○

      the response optional property created_at became not read-only for the status 201

      response-optional-property-became-not-read-only

    • ○

      the response optional property updated_at became not read-only for the status 201

      response-optional-property-became-not-read-only

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 42666333165531See the full diff
    • ▲

      the request property config became not nullable

      request-property-became-not-nullable

    • ▲

      the request property tags became not nullable

      request-property-became-not-nullable

    • ▲

      the request property config became required

      request-property-became-required

    • ○

      the response property config became required for the status 201

      response-property-became-required

  • 08ead66e9ebb68See the full diff
    • ▲

      the request property name became required

      request-property-became-required

    • ▲

      the request property prefix became required

      request-property-became-required

    • ▲

      the response property config became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property description became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property id became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property tags became nullable for the status 201

      response-property-became-nullable

    • ○

      the request optional property id became not read-only

      request-optional-property-became-not-read-only

    • ○

      the request property config became nullable

      request-property-became-nullable

    • ○

      the request property description became nullable

      request-property-became-nullable

    • ○

      the request property id became nullable

      request-property-became-nullable

    • ○

      the request property tags became nullable

      request-property-became-nullable

    • ○

      the response optional property id became not read-only for the status 201

      response-optional-property-became-not-read-only

    • ○

      the response property name became required for the status 201

      response-property-became-required

    • ○

      the response property prefix became required for the status 201

      response-property-became-required

    This revision also has 88 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog