This topic describes how to delete a credential by using the API.
Notice
Hard deletion is irreversible. Once a credential is deleted, it cannot be recovered.
API call
If you set a password, you must authenticate. For more information, see API hybrid encryption.
Request path
DELETE /api/v1/security/credential/:id
Request parameters
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| id | int | Yes | 1 | The ID of the credential. This parameter is specified in the path. |
Response
Parameter |
Type |
Description |
|---|---|---|
| successful | bool | Indicates whether the request was successful. |
| timestamp | time.Time | The timestamp when the server completed the request. |
| duration | int | The time taken by the server to process the request, in milliseconds. |
| status | int | The HTTP status code. |
| traceId | string | The trace ID of the request. |
| error | ApiError | The error information, which contains the following parameters:
|
Examples
Request example
DELETE 10.10.10.1:2886/api/v1/security/credential/1
Response example
{
"successful": true,
"timestamp": "2025-10-14T15:16:01.277047628+08:00",
"duration": 15,
"status": 200,
"traceId": "e6f64ba7f54e7a50"
}