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

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
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).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
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

Create or update a node

Create or update a node.

put

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

nodeIdstring(uuid)required

Node identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Upsert Node Request

The request schema to upsert a Node.

* Additional properties are NOT allowed.
hostnamestring

Example:node1.my.domain.com

typestring

Example:knep

versionstring

Example:1.0

config_versionstring
errorsarray[object]
* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Example response

itemobject
Show Child Parameters
put/control-planes/{controlPlaneId}/nodes/{nodeId}

Body

{}
 
application/json

Create or Update the declarative config

Create or Update the declarative config

put

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

DeclarativeConfig

configstring

The configuration as string. Must be valid yaml or json.

Response

application/json

Declarative Config Response

DeclarativeConfig

configstring

The configuration as string. Must be valid yaml or json.

versionstring(uuid)read-only

An uuid identifier (v7) of the version of the config payload.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/control-planes/{controlPlaneId}/declarative-config

Body

{}
 
application/json

Get the declarative configuration

Returns the declarative configuration set for the control plane.

get

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

Response

200 application/json

Declarative Config Response

DeclarativeConfig

configstring

The configuration as string. Must be valid yaml or json.

versionstring(uuid)read-only

An uuid identifier (v7) of the version of the config payload.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/control-planes/{controlPlaneId}/declarative-config
 
200 application/json

Delete the declarative config

Delete the declarative config

delete

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

Response

The configuration was deleted successfully.

delete/control-planes/{controlPlaneId}/declarative-config