Help Center/ Host Security Service/ API Reference/ API Description/ Web Tamper Protection/ Querying the Status of Static WTP for a Server
Updated on 2025-09-22 GMT+08:00
View PDF

Querying the Status of Static WTP for a Server

Function

This API is used to query the status of static WTP for a server.

URI

GET /v5/{project_id}/webtamper/static/protect-history

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_id

No

String

Host ID. If this parameter is left empty, all the servers are queried.

start_time

Yes

Long

Start time (ms)

end_time

Yes

Long

End time (ms)

limit

Yes

Integer

limit

offset

Yes

Integer

offset

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

host_name

String

Server name

protect_status

String

Protection status. Its value can be:

  • close

  • opened

total_num

Long

total number of static WTPs

data_list

Array of HostProtectHistoryResponseInfo objects

data list
Table 5 HostProtectHistoryResponseInfo

Parameter

Type

Description

occr_time

Long

Static WTP detection time (ms)

file_path

String

Tampered file path

process_id

String

Process ID. This parameter is returned if the OS is Windows.

process_name

String

Process name. This parameter is returned if the OS is Windows.

process_cmd

String

Process command line. This parameter is returned if the OS is Windows.

Example Requests

Query the static WTP status of a server where target ID is caa958ad-a481-4d46-b51e-6861b8864515, start time is 1668563099000, and end time is 1668563199000.

GET https://{endpoint}/v5/{project_id}/webtamper/static/protect-history

{
  "host_id" : "caa958ad-a481-4d46-b51e-6861b8864515",
  "start_time" : 1668563099000,
  "end_time" : 1668563199000,
  "limit" : 10,
  "offset" : 0
}

Example Responses

Status code: 200

successful response

{
  "host_name" : "ecs-ubuntu",
  "protect_status" : "opened",
  "total_num" : 1,
  "data_list" : [ {
    "occr_time" : 1668156691000,
    "file_path" : "/root/test/tamper/test.xml",
    "process_id" : "18672",
    "process_name" : "program1",
    "process_cmd" : "del test.xml"
  } ]
}

Status Codes

Status Code

Description

200

successful response

Error Codes

See Error Codes.

Parent Topic: Web Tamper Protection