Sign in

Archive Vault

post/v1/vaults/{vault_id}/archive?beta=true

Path parameters

vault_idstring required

Path parameter vault_id

Headers

anthropic-versionstring
anthropic-betastring
anthropic-workspace-idstring

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Response

Successful response (OK)

type'vault' required
idstring required

Unique identifier for the vault.

display_namestring required

Human-readable name for the vault.

metadataobject required

Arbitrary key-value metadata attached to the vault.

created_atstring date-time required

A timestamp in RFC 3339 format

updated_atstring date-time required

A timestamp in RFC 3339 format

archived_atstring date-time required

A timestamp in RFC 3339 format

Example response

{
  "type": "vault",
  "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv",
  "display_name": "Example vault",
  "metadata": {
    "environment": "production"
  },
  "created_at": "2026-03-15T10:00:00Z",
  "updated_at": "2026-03-15T10:00:00Z",
  "archived_at": null
}

Changes