Help Center/ Host Security Service/ API Reference/ API Description/ Web Tamper Protection/ Querying the Protection List
Updated on 2025-09-22 GMT+08:00
View PDF

Querying the Protection List

Function

This API is used to query the protection list.

URI

GET /v5/{project_id}/webtamper/hosts

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID

host_name

No

String

Server name

host_id

No

String

Host ID

public_ip

No

String

EIP

private_ip

No

String

Private IP address

group_name

No

String

Server group name

os_type

No

String

OS type. Its value can be:

  • linux

  • windows

protect_status

No

String

Protection status.

  • closed: disabled

  • opened: protection enabled

agent_status

No

String

Agent status. Its value can be:

  • not_installed: The agent is not installed.

  • online: The agent is online.

  • offline: The agent is offline.

limit

No

Integer

Default value: 10

offset

No

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0.

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.

region

Yes

String

Region Id

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data_list

Array of WtpProtectHostResponseInfo objects

data list

total_num

Integer

total number of WTP protected servers
Table 5 WtpProtectHostResponseInfo

Parameter

Type

Description

host_name

String

Server name

host_id

String

Host ID

public_ip

String

EIP

private_ip

String

Private IP address

group_name

String

Server group name

os_bit

String

OS bit version

os_type

String

OS (linux or windows)

protect_status

String

Protection status. Its value can be:

  • closed

  • opened

rasp_protect_status

String

Dynamic WTP status.

  • closed

  • opened

anti_tampering_times

Long

Number of blocked tampering attacks

detect_tampering_times

Long

Number of detected tampering attacks

last_detect_time

Long

Latest detection time (ms)

scheduled_shutdown_status

String

Status of scheduled protection.

  • opened

  • closed

agent_status

String

Agent status.

  • not_installed: The agent is not installed.

  • online: The agent is online.

  • offline: The agent is offline.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "total_num" : 1,
  "data_list" : [ {
    "host_name" : "test",
    "host_id" : "000411f9-42a7-4acd-80e6-f7b9d3db895f",
    "public_ip" : "",
    "private_ip" : "192.168.0.70",
    "group_name" : "testGroup",
    "os_bit" : "64",
    "os_type" : "Linux",
    "protect_status" : "opened",
    "rasp_protect_status" : "opened",
    "anti_tampering_times" : 0,
    "detect_tampering_times" : 0,
    "last_detect_time" : 0,
    "agent_status" : "online"
  } ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent Topic: Web Tamper Protection