Deletes a Credential from a Vault.
Path
DELETE /api/v1/forward/vaults/{id}/credentials/{cred_id}
Request headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Vault ID. |
cred_id | string | Yes | Credential ID. |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | No | Optional; used only for Identity-owned resources. PAT callers can pass it explicitly; omitting it uses the administrator scope. For SAT, issue an Identity-scoped token and do not explicitly pass this parameter, or the request returns HTTP 400. See Identity ownership. |
Example request
Example response
Response fields
| Field | Type | Description |
|---|---|---|
id | string | ID of the deleted resource. |
type | string | Deletion result type. |
deleted | boolean | Whether the resource was deleted. |
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | The request body, path parameters, or pagination parameters are invalid, including an invalid auth object, such as static_bearer without token. Also returned if SAT explicitly includes identity_id. |
| 401 | authentication_error | The authentication token is missing or invalid. |
| 403 | permission_error | Vault Owner mismatch for a PAT without identity_id or an Admin SAT, or other insufficient permissions. |
| 404 | not_found_error | The Vault or Credential does not exist or is not visible. identity_id is invalid, disabled, or does not belong to the caller, or the target resource does not belong to the current Identity scope. |
| 409 | conflict_error | The Credential state conflicts with the operation. |
| 500/502/503 | api_error | Forward or a dependent service failed. |
Authentication data in Credential requests is sensitive. Some detailed validation messages are replaced with a generic redacted message; the HTTP status and error type remain unchanged.