Skip to main content
GET
Get a vault

Authorizations

Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens - a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

Path Parameters

id
string
required

A vault id

Pattern: ^vlt_[^\s/]{1,64}$
Example:

"vlt_j572abc123def456"

Response

Vault

id
string
required

A vault id

Pattern: ^vlt_[^\s/]{1,64}$
Example:

"vlt_j572abc123def456"

workspace_id
string
required
Required string length: 1 - 53
name
string
required
Required string length: 1 - 100
state
enum<string>
required

DELETING: deletion was accepted. Nothing in the vault can be used any more, and Akua Connect is erasing its state; the vault disappears when that is done.

Available options:
ACTIVE,
DELETING
is_default
boolean
required

True for the Workspace's default vault, which cannot be deleted.

external_id
string | null
required

The reseller's own id for the end customer this vault represents, if any.

Maximum string length: 100
metadata
object
required
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0