Archive Vault

Prerequisites

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

Endpoint

POST /vaults/{vault_id}/archive

Path parameters

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

Request example

curl -X POST "$AGENTSTUDIO_URL/vaults/vlt_xxx/archive" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Response example

{
  "id": "vlt_xxx",
  "type": "vault",
  "display_name": "production-keys",
  "metadata": {
    "environment": "production"
  },
  "archived_at": "2026-07-10T08:00:00Z",
  "created_at": "2026-06-20T10:00:00Z",
  "updated_at": "2026-07-10T08:00: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	Archive timestamp, ISO 8601
`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 example

​Response example

​Response fields

​Error codes

Prerequisites

Endpoint

Path parameters

Request example

Response example

Response fields

Error codes