Delete Credential
Updated at:
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
| 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 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
| Field | Type | Description |
|---|---|---|
id | string | ID of the deleted Credential |
type | string | Always credential_deleted |
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 |
Is this page helpful?