Update Vault

Prerequisites

Endpoint and authentication configured. For details, see Overview and authentication.

Endpoint

POST /vaults/{vault_id}

Path parameters

Field	Required	Type	Description
`vault_id`	Yes	string	Vault ID, format `vlt_xxx`

Request body

At least one of display_name or metadata must be provided.

Field	Required	Type	Description
`display_name`	No	string	New human-readable name, 1–255 characters
`metadata`	No	object	Patch semantics: setting a key to a string adds or overwrites it; setting a key to `null` deletes that key

Request example

curl -X POST "$AGENTSTUDIO_URL/vaults/vlt_xxx" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "production-keys-renamed",
    "metadata": {
      "environment": "production",
      "deprecated_key": null
    }
  }'

Response example

{
  "id": "vlt_xxx",
  "type": "vault",
  "display_name": "production-keys-renamed",
  "metadata": {
    "environment": "production"
  },
  "archived_at": null,
  "created_at": "2026-06-20T10:00:00Z",
  "updated_at": "2026-07-01T14:30:00Z"
}

Response fields

Field	Type	Description
`id`	string	Vault ID, format `vlt_xxx`
`type`	string	Always `vault`
`display_name`	string	Human-readable name of the Vault
`metadata`	object	Custom key-value pairs
`archived_at`	string \| null	Archive timestamp; `null` if not archived
`created_at`	string	Creation time, ISO 8601
`updated_at`	string	Last update time, ISO 8601

Error codes

HTTP status	Error code	Description
400	`InvalidParameter`	Required parameter missing or invalid
401	`InvalidApiKey`	Invalid API key provided

​Prerequisites

​Endpoint

​Path parameters

​Request body

​Request example

​Response example

​Response fields

​Error codes

Prerequisites

Endpoint

Path parameters

Request body

Request example

Response example

Response fields

Error codes