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}
 

Event Gateway Vault Secrets

List Vault Secrets

Returns a list of secrets associated with the specified Event Gateway Vault.

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

vaultIdstring(uuid)required

The ID of the Vault.

Response

application/json

A paginated list response for a collection of vault secrets.

metaobject

Pagination metadata.

Show Child Parameters
dataarray[object]

A secret contained by a vault.

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

Create Vault Secret

Creates a new secret associated with the specified Event Gateway Vault.

post

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 creating a vault secret.

EventGatewayModifyVaultSecret

The typed schema of the vault secret to modify it.

keystringrequired

The key of the vault secret.

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

>= 1 characters<= 255 characters

valuestringrequired

The value of the vault secret.

>= 1 characters<= 65535 characters

Response

application/json

Created

EventGatewayVaultSecret

A secret contained by a vault.

idstring(uuid)required

The unique identifier of the secret.

keystringrequired

The key of the vault secret.

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

>= 1 characters<= 255 characters

valuestringrequired

The value of the vault secret.

>= 1 characters<= 65535 characters

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

post/event-gateways/{gatewayId}/vaults/{vaultId}/secrets

Body

{ "key": "key", "value": "value" }
 
application/json

Get Vault Secret

Returns information about a secret contained within the specified Event Gateway Vault.

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.

secretIdstring(uuid)required

The ID of the Vault Secret.

Response

application/json

A single vault secret object.

EventGatewayVaultSecret

A secret contained by a vault.

idstring(uuid)required

The unique identifier of the secret.

keystringrequired

The key of the vault secret.

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

>= 1 characters<= 255 characters

valuestringrequired

The value of the vault secret.

>= 1 characters<= 65535 characters

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

get/event-gateways/{gatewayId}/vaults/{vaultId}/secrets/{secretId}
 
application/json