Help Center/ Web Application Firewall/ API Reference (Kuala Lumpur Region)/ API/ Event Management/ This API is used to query the list of events.

Updated on 2022-08-09 GMT+08:00

View PDF

This API is used to query the list of events.

Function

Querying the List of Events

URI

GET /v1/{project_id}/waf/event

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
recent	Yes	String	Log query time range
hosts	No	Array	Domain name ID. It can be obtained from the protected website list.
page	No	Integer	Page number
pagesize	No	Integer	Number of records per page

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 (value of X-Subject-Token in the response header).
Content-Type	Yes	String	Content type Default: application/json;charset=utf8

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Number of attack events
items	Array of ListEventItems objects	Details about an attack event

**Table 5** ListEventItems
Parameter	Type	Description
id	String	Event ID
time	Long	Count
policyid	String	Policy ID
sip	String	Source IP address
host	String	Domain name
url	String	Attacked URL
attack	String	Attack type XSS attacks: xss or sqli Command injection: cmdi Malicious crawlers: robot Local file inclusion: lfi Remote file inclusion: rfi Website Trojans: webshell CC attack: cc Precise protection: custom_custom IP address blacklist and whitelist: custom_whiteblackip Geolocation access control: custom_geoip Anti-tamper protection: antitamper Anti-crawler protection: anticrawler Data leakage prevention: leakage Illegal requests: illegal Other attack types: vuln
rule	String	ID of the matched rule
payload	String	Hit payload
action	String	Protective action
request_line	String	Request method and path
headers	headers object	Request header
cookie	String	Request cookie
status	String	Response code status
region	String	Region
host_id	String	Domain name ID
response_time	Long	Time to response
response_size	Integer	Response body size
response_body	String	Response body

**Table 6** headers
Parameter	Type	Description
content-length	String	Request length
host	String	Domain name
content-type	String	Content type
user-agent	String	Proxy
accept	String	Type of the received content

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error code message

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error code message

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error code message

Example Requests

None

Example Responses

None

Status Codes

Status Code	Description
200	ok
400	Request failed
401	Insufficient token permissions
500	Internal server error

Error Codes

See Error Codes.

Parent topic: Event Management

Previous topic: Event Management

Next topic: This API is used to query details of an event.

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.