Archive Credential

Prerequisites

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

Endpoint

POST /vaults/{vault_id}/credentials/{credential_id}/archive

Path parameters

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

Request example

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

Response example

{
  "id": "cred_xxx",
  "type": "credential",
  "vault_id": "vlt_xxx",
  "display_name": "Third-party API key",
  "auth": {
    "type": "environment_variable",
    "secret_name": "API_KEY",
    "networking": {
      "allowed_hosts": [
        "api.example.com",
        "*.example.com"
      ]
    },
    "injection_location": {
      "header": true
    }
  },
  "metadata": {},
  "archived_at": "2026-07-15T06:00:00Z",
  "created_at": "2026-07-10T08:00:00Z",
  "updated_at": "2026-07-15T06:00:00Z",
  "request_id": "req_xxx"
}

Response fields

Field	Type	Description
`id`	string	Credential ID, format `cred_xxx`
`type`	string	Always `credential`
`vault_id`	string	Vault ID that the Credential belongs to
`display_name`	string	Human-readable name of the Credential
`auth`	object	Authentication information with sensitive values masked
`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
`request_id`	string	Unique request identifier

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