Skip to main content

Delete Credential

Permanently deletes a specified Credential. This operation cannot be undone.

Prerequisites

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

Endpoint

DELETE /vaults/{vault_id}/credentials/{credential_id}

Path parameters

FieldRequiredTypeDescription
vault_idYesstringVault ID, format vlt_xxx
credential_idYesstringCredential ID, format cred_xxx

Request example

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

Response example

{
  "id": "cred_xxx",
  "type": "credential_deleted",
  "request_id": "req_xxx"
}

Response fields

FieldTypeDescription
idstringID of the deleted Credential
typestringAlways credential_deleted
request_idstringUnique request identifier

Error codes

HTTP statusError codeDescription
400InvalidParameterRequired parameter missing or invalid
401InvalidApiKeyInvalid API key provided
Managed Agent API
Flow Agent API
Sandbox API
RAG API
Long-term Memory
ParseX API
Security API
Framework Integration