Help Center/ Host Security Service/ API Reference/ API Description/ Web Tamper Protection/ Enabling or Disabling Dynamic Web Tamper Protection
Updated on 2026-04-03 GMT+08:00

Enabling or Disabling Dynamic Web Tamper Protection

Function

This API is used to turn on or off dynamic web tamper protection.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v5/{project_id}/webtamper/rasp/status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

region

No

String

Definition

Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

host_id_list

Yes

Array of strings

Definition

Server ID list. Only Linux servers are supported. For this parameter to be valid, the server must be protected by WTP.

Constraints

You need to use the ListWtpProtectHost API to query the list of servers protected by WTP. In the response body of the ListWtpProtectHost API, the host_id whose os_type is Linux is the ID of the server that meets the modification conditions.

Range

1 to 200 items

Default Value

N/A

status

Yes

Boolean

Definition

Whether to enable dynamic WTP. This parameter is supported only for Linux servers.

Constraints

N/A

Range

  • True: Dynamic WTP is enabled.

  • False: Dynamic WTP is disabled.

Default Value

False

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Enable dynamic WTP.

POST https://{endpoint}/v5/{project_id}/webtamper/rasp/status

{
  "host_id_list" : [ "96ae7317-b5c4-4bc8-aa90-eda53f23e99e" ],
  "status" : true
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.