Skip to main content

Delete vault

Delete a vault and all credentials under it. Deletion cannot be undone.

Endpoint

DELETE /vaults/{vault_id} 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)Vault ID. Treat it as an opaque ID

Request example

curl -sS -X DELETE "$BASE_URL/vaults/vlt_xxx" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Response fields

200, returns a delete envelope:id stringID of the deleted vaultobject stringVault deletion result object type, fixed as vault.deleteddeleted booleanWhether deletion succeeded, true on successDeleting a vault deletes all credentials under it. After deletion, retrieve and delete return 404.

Response example

{
  "id": "vlt_xxx",
  "object": "vault.deleted",
  "deleted": true
}

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 vault does not exist, is deleted, or belongs to another workspace
500server_error / server_errorRetry later. If it keeps failing, submit a ticket with x-request-id