List Vaults

Returns a list of vaults associated with the specified Event Gateway.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter documents returned in the response.

Show Child Parameters

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Response

application/json

A paginated list response for a collection of vaults.

metaobject

Pagination metadata.

Show Child Parameters
dataOne Of
array[object]
EventGatewayEnvVaultobject

An environment vault.

Show Child Parameters
get/event-gateways/{gatewayId}/vaults
 
application/json

Create Vault

Creates a new vault associated with the specified Event Gateway.

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Body

application/json

The request schema for creating a vault.

EventGatewayModifyVault

EventGatewayModifyVault

The typed schema of the vault to modify it.

One Of
namestringrequired

The name of the vault.

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 255 characters

typestringrequired

The type of the vault.

Allowed values:env

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

descriptionstring

A human-readable description of the vault.

Default:

<= 512 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

configobjectrequired

The configuration of the environment vault.

Show Child Parameters

Response

application/json

Created

EventGatewayVault

One Of
namestringrequired

The name of the vault.

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 255 characters

typestringrequired

The type of the vault.

Allowed values:env

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

descriptionstring

A human-readable description of the vault.

Default:

<= 512 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

configobjectrequired

The configuration of the environment vault.

Show Child Parameters
post/event-gateways/{gatewayId}/vaults

Body

{}
 
application/json

Get a Vault

Returns information about a specific vault associated with the Event Gateway.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

vaultIdstring(uuid)required

The ID of the Vault.

Response

application/json

A single vault object.

EventGatewayVault

One Of
namestringrequired

The name of the vault.

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 255 characters

typestringrequired

The type of the vault.

Allowed values:env

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

descriptionstring

A human-readable description of the vault.

Default:

<= 512 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

configobjectrequired

The configuration of the environment vault.

Show Child Parameters
get/event-gateways/{gatewayId}/vaults/{vaultId}
 
application/json

Update Vault

Updates an existing vault associated with the specified Event Gateway.

put

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

vaultIdstring(uuid)required

The ID of the Vault.

Body

application/json

The request schema for updating a vault.

EventGatewayModifyVault

EventGatewayModifyVault

The typed schema of the vault to modify it.

One Of
namestringrequired

The name of the vault.

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 255 characters

typestringrequired

The type of the vault.

Allowed values:env

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

descriptionstring

A human-readable description of the vault.

Default:

<= 512 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

configobjectrequired

The configuration of the environment vault.

Show Child Parameters

Response

application/json

Updated vault object.

EventGatewayVault

One Of
namestringrequired

The name of the vault.

Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$

>= 1 characters<= 255 characters

typestringrequired

The type of the vault.

Allowed values:env

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

descriptionstring

A human-readable description of the vault.

Default:

<= 512 characters

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

configobjectrequired

The configuration of the environment vault.

Show Child Parameters
put/event-gateways/{gatewayId}/vaults/{vaultId}

Body

{}
 
application/json

Delete Vault

Deletes a specific vault associated with the Event Gateway.

delete

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

vaultIdstring(uuid)required

The ID of the Vault.

Response

No Content

delete/event-gateways/{gatewayId}/vaults/{vaultId}