Get a Vault
Returns information about a specific vault associated with the Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Vault.
Response
application/json
Response
A single vault object.
EventGatewayVault
One OfThe name of the vault.
Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$
>= 1 characters<= 255 characters
The type of the vault.
Allowed values:env
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
A human-readable description of the vault.
Default:
<= 512 characters
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"}
The configuration of the environment vault.
Show Child Parameters
Authentication
Path Parameters
Update Vault
Updates an existing vault associated with the specified Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Vault.
Body
application/json
Body
The request schema for updating a vault.
EventGatewayModifyVault
The typed schema of the vault to modify it.
One OfThe name of the vault.
Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$
>= 1 characters<= 255 characters
The type of the vault.
Allowed values:env
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
A human-readable description of the vault.
Default:
<= 512 characters
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"}
The configuration of the environment vault.
Show Child Parameters
Response
application/json
Response
Updated vault object.
EventGatewayVault
One OfThe name of the vault.
Match pattern:^[\p{L}\p{N}][\p{L}\p{N} _\-\.']*[\p{L}\p{N}]$
>= 1 characters<= 255 characters
The type of the vault.
Allowed values:env
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
A human-readable description of the vault.
Default:
<= 512 characters
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"}
The configuration of the environment vault.
Show Child Parameters
Authentication
Path Parameters
Body
Delete Vault
Deletes a specific vault associated with the Event Gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Vault.
Response
Response
No Content
Authentication
Path Parameters
Event Gateway Vault Secrets
List Vault Secrets
Returns a list of secrets associated with the specified Event Gateway Vault.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Filter documents returned in the response.
Show Child Parameters
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the Vault.
Response
application/json
Response
A paginated list response for a collection of vault secrets.
Pagination metadata.
Show Child Parameters
A secret contained by a vault.