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

Removing File Paths

Function

This API is used to remove the file paths added for backup.

Debugging

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

URI

POST /v3/{project_id}/agents/{agent_id}/remove-path

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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

remove_path

Yes

Array of strings

Details of the paths to be removed

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

removed

Array of strings

List of the removed paths

not_existed

Array of strings

List of the paths that are not existed

Example Requests

Removing File Paths

https://{endpoint}/v3/{project_id}/agents/{agent_id}/remove-path

{
  "remove_path" : [ "/tmp", "/home" ]
}

Example Responses

Status code: 200

OK

{
  "removed" : [ "/tmp" ],
  "not_existed" : [ "/home" ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.