Updated on 2025-10-17 GMT+08:00

Removing an Agent

Function

This API is used to remove an agent. All backups of an agent will be deleted after the agent is removed.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

DELETE /v3/{project_id}/agents/{agent_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

agent_id

Yes

String

Agent ID

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header.

Response Parameters

Status code: 200

OK

None

Example Requests

Deregistering an agent

DELETE https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents/6dd81d7d-a4cb-443e-b8ed-1af0bd3a261b

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.