Updated on 2024-05-11 GMT+08:00

Removing a Client

Function

This API is used to remove a client. All backups of a client will be deleted after the client 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

Client 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 The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

None

Example Requests

Deregistering a client

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.