Querying the Status of Dynamic WTP for a Server_Web Tamper Protection_API Description_API Reference (Ally Region)

Function

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

URI

GET /v5/{project_id}/webtamper/rasp/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	Server 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, which specifies the start position of the record to be returned.
alarm_level	No	Integer	Alarm severity. Its value can be: 1: low-risk 2: medium risk 3: high risk 4: major
severity	No	String	Threat level. Its value can be: Security Low: low risk Medium: medium risk High: high risk Critical
protect_status	No	String	Protection status. closed: disabled opened: protection enabled

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 user token.
region	Yes	String	Region Id

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Long	total number of dynamic WTPs
data_list	Array of HostRaspProtectHistoryResponseInfo objects	data list

**Table 5** HostRaspProtectHistoryResponseInfo
Parameter	Type	Description
host_ip	String	Server IP address
host_name	String	Server name
alarm_time	Long	Alarm time of dynamic WTP (ms)
threat_type	String	Threat type
alarm_level	Integer	Alarm severity
source_ip	String	IP address of the attacker
attacked_url	String	URL of the attack request

Example Requests

Query the dynamic 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/rasp/protect-history

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

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "host_ip" : "192.168.5.98",
    "host_name" : "hss-test",
    "alarm_level" : 2,
    "alarm_time" : 1668394634000,
    "attacked_url" : "/vulns/001-dir-1.jsp",
    "source_ip" : "10.100.30.200",
    "threat_type" : "Path Traversal"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Querying the Status of Dynamic WTP for a Server