Disabling Ransomware Prevention

Updated on 2024-01-31 GMT+08:00

View PDF

Function

This API is used to disable ransomware prevention.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/ransomware/protection/close

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	User project ID Minimum: 1 Maximum: 256

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 1 Maximum: 256

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It 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 a token. Minimum: 1 Maximum: 32768
region	Yes	String	region id Minimum: 0 Maximum: 128

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
host_id_list	Yes	Array of strings	IDs of servers where ransomware protection needs to be disabled Minimum: 0 Maximum: 64 Array Length: 0 - 20
agent_id_list	Yes	Array of strings	IDs of agents where ransomware prevention needs to be disabled Minimum: 0 Maximum: 64 Array Length: 0 - 20
close_protection_type	Yes	String	Type of disabled protection. The options are as follows: close_all: Disable all protection. close_anti: Ransomware prevention is disabled. close_backup: Disable the backup function. Minimum: 0 Maximum: 64

Response Parameters

None

Example Requests

Disable ransomware protection for the server. The target server ID is 71a15ecc-049f-4cca-bd28-5e90aca1817f, and the agent ID of the target server is c9bed5397db449ebdfba15e85fcfc36accee954daf5cab0528bab59bd8.

POST https://{endpoint}/v5/{project_id}/ransomware/protection/close

{
  "close_protection_type" : "close_anti",
  "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ],
  "agent_id_list" : [ "c9bed5397db449ebdfba15e85fcfc36accee954daf5cab0528bab59bd8" ]
}