Skip to main content
PATCH
Update a vault

Authorizations

Authorization
string
header
required

Bearer token for the authenticated caller.

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_j572abc123def4"

idempotency-key
string

Optional caller-supplied idempotency key. Any non-empty key up to 64 characters is accepted. Endpoint-specific documentation describes how the key is used.

Required string length: 1 - 64
Example:

"create-prod-2026-05-07"

if-match
string
required

The etag of the resource version the client last read. Required on writes when the resource exposes an etag field. Mismatch returns 409 ABORTED with the current etag in the error metadata.

Required string length: 1 - 256
Example:

"42"

Path Parameters

vault
string
required

A vault id chosen by its creator, unique in the Workspace. default is the Workspace vault.

Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
Example:

"default"

Body

application/json
display_name
string
Required string length: 1 - 100
labels
object
annotations
object

Opaque key-value data for clients (AIP-148).

Response

Vault

name
string
required

Resource name vaults/{vault}.

Example:

"vaults/default"

vault_id
string
required

A vault id chosen by its creator, unique in the Workspace. default is the Workspace vault.

Pattern: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$
Example:

"default"

workspace_id
string
required
Required string length: 1 - 53
display_name
string
required
Required string length: 1 - 100
labels
object
required
annotations
object
required

Opaque key-value data for clients (AIP-148).

created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
updated_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
etag
string
required

Pass as If-Match on writes. OUTPUT_ONLY.

Maximum string length: 64