ANanthropics

Update a Credential

Changed on
post/v1/vaults/{vault_id}/credentials/{credential_id}?beta=true

Request

Path parameters

vault_idstring required

Identifier of the vault containing the credential.

credential_idstring required

Unique identifier of the credential to update.

Headers

anthropic-versionstring

The version of the Claude API you want to use.

Read more about versioning and our version history here.

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.

Request body

display_namestring nullable

Updated human-readable name for the credential. 1-255 characters.

metadataobject nullable

Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved.

Example request

{
  "display_name": "Example credential",
  "metadata": {
    "environment": "production"
  }
}

Response

Successful response (OK)

type'vault_credential' required
idstring required

The unique ID of the credential (vcrd_...).

vault_idstring required

Identifier of the vault this credential belongs to.

display_namestring nullable

Human-readable name for the credential.

metadataobject required

Arbitrary key-value metadata attached to the credential.

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_credential",
  "id": "vcrd_011CZkZEMt8gZan2iYPQfSkw",
  "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv",
  "display_name": "Example credential",
  "metadata": {
    "environment": "production"
  },
  "created_at": "2026-03-15T10:00:00Z",
  "updated_at": "2026-03-15T10:00:00Z",
  "archived_at": null,
  "auth": {
    "type": "static_bearer",
    "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse"
  }
}

Changes

  • 037a593978dcRevision changes
    • info

      added the enum value admin-user-sign-out-2026-10-08 to the property items/anyOf[subschema #2]/ of the header request parameter anthropic-beta

  • 9578ce4001ddRevision changes
    • breaking

      added the pattern ^[^\x00-\x1f\x7f]*$ to the request property //////////

    • breaking

      added the pattern ^[^\x00-\x1f\x7f]*$ to the request property //////////

    • breaking

      added the pattern ^[^\x00-\x1f\x7f]*$ to the request property //////////