Skip to main content
POST
Archive Vault
Every request requires ?beta=true.

Authorizations

X-Api-Key
string
header
default:sk-ant-local-default
required

OMA workspace API key.

Headers

anthropic-version
string
anthropic-beta
string

Path Parameters

vault_id
string
required

Path parameter vault_id

Query Parameters

beta
enum<boolean>
required

Selects the beta API contract for this endpoint. Must be true.

Available options:
true

Response

Successful response (OK)

A vault that stores credentials for use by agents during sessions.

type
enum<string>
required
Available options:
vault
Example:

"vault"

id
string
required

Unique identifier for the vault.

Example:

"vlt_011CZkZDLs7fYzm1hXNPeRjv"

display_name
string
required

Human-readable name for the vault.

Example:

"Example vault"

metadata
object
required

Arbitrary key-value metadata attached to the vault.

Example:
created_at
string<date-time>
required

A timestamp in RFC 3339 format

Example:

"2026-03-15T10:00:00Z"

updated_at
string<date-time>
required

A timestamp in RFC 3339 format

Example:

"2026-03-15T10:00:00Z"

archived_at
string<date-time> | null
required

When the vault was archived. Null if not archived.

Example:

null