Help Center/ Host Security Service/ API Reference/ API Description/ Web Tamper Protection/ Querying the Status of Dynamic WTP for a Server
Updated on 2024-01-31 GMT+08:00

Querying the Status of Dynamic WTP for a Server

Function

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

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant ID

Minimum: 0

Maximum: 64

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project

Minimum: 0

Maximum: 64

host_id

Yes

String

Host Id

Minimum: 0

Maximum: 128

start_time

Yes

Long

Start time

Minimum: 0

Maximum: 4070880000000

end_time

Yes

Long

End time

Minimum: 0

Maximum: 4070880000000

limit

Yes

Integer

limit

Minimum: 0

Maximum: 100

offset

Yes

Integer

offset

Minimum: 0

Maximum: 100

alarm_level

No

Integer

Alarm severity

Minimum: 0

Maximum: 100

severity

No

String

Threat level. Its value can be:

  • Security

  • Low: low risk

  • Medium: medium risk

  • High: high risk

  • Critical

Minimum: 0

Maximum: 32

protect_status

No

String

Protection status.

  • closed: disabled

  • opened: protection enabled

Minimum: 0

Maximum: 32

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token

Minimum: 1

Maximum: 32768

region

Yes

String

Region Id

Minimum: 0

Maximum: 32

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Long

total number

Minimum: 0

Maximum: 200000

data_list

Array of HostRaspProtectHistoryResponseInfo objects

data list

Array Length: 0 - 200000

Table 5 HostRaspProtectHistoryResponseInfo

Parameter

Type

Description

host_ip

String

Server IP address

Minimum: 0

Maximum: 64

host_name

String

Server name

Minimum: 0

Maximum: 64

alarm_time

Long

Alarm time

Minimum: 0

Maximum: 4070880000000

threat_type

String

Threat type

Minimum: 0

Maximum: 64

alarm_level

Integer

Alarm severity

Minimum: 0

Maximum: 100

source_ip

String

Source IP address

Minimum: 0

Maximum: 128

attacked_url

String

Attack URL

Minimum: 0

Maximum: 2000

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

successful response

{
  "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

successful response

Error Codes

See Error Codes.