Skip to main content

Archive credential

Archive a credential. This Bailian extension has no restore endpoint.

Endpoint

POST /vaults/{vault_id}/credentials/{credential_id}/archive Paths are relative to the Base URL. Send Authorization: Bearer $DASHSCOPE_API_KEY on every request. For authentication details, see Authentication.

Path parameters

vault_id string (required)Parent vault ID. Treat it as an opaque IDcredential_id string (required)Credential ID. Treat it as an opaque IDThe request has no body.

Request example

curl -sS -X POST "$BASE_URL/vaults/vlt_xxx/credentials/vcrd_xxx/archive" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Response fields

200, returns the archived credential:id stringCredential IDobject stringCredential object type, fixed as vault.credentialvault_id stringParent vault IDname stringDisplay namecreated_at integerCreation time in Unix secondsupdated_at integerLast update time in Unix secondsmetadata objectMetadata, string key-value pairs; {} when not set
type stringAuthentication type, fixed as environment_variablesecret_name stringEnvironment variable name
type stringNetwork access type, limited or unrestrictedallowed_hosts arrayDomains or IPv4 addresses allowed for limited
The response does not return archived_at, status, secret_value, the key identifier, or injection_location. An archived credential can still be retrieved, and the default list includes both active and archived. There is no restore endpoint. Archiving a vault also archives its child credentials.

Response example

{
  "id": "vcrd_xxx",
  "object": "vault.credential",
  "vault_id": "vlt_xxx",
  "name": "crm-token",
  "created_at": 1793941200,
  "updated_at": 1793944800,
  "metadata": {"team": "support"},
  "auth": {
    "type": "environment_variable",
    "secret_name": "CRM_TOKEN",
    "networking": {
      "type": "limited",
      "allowed_hosts": ["api.example.com"]
    }
  }
}

Error codes

For the error response structure, see Errors.
HTTP statusError type / codeSolution
401authentication_error / invalid_api_keySend a valid Authorization: Bearer $DASHSCOPE_API_KEY header
404not_found_error / not_found_errorThe credential does not exist, is deleted, does not belong to the parent vault, or belongs to another workspace
500server_error / server_errorRetry later. If it keeps failing, submit a ticket with x-request-id