Help Center/ Web Application Firewall/ API Reference (Kuala Lumpur Region)/ API/ Event Management/ This API is used to query details of an event.
Updated on 2022-08-09 GMT+08:00
View PDF
Share

This API is used to query details of an event.

Function

Querying Details of an Event

URI

GET /v1/{project_id}/waf/event/{eventid}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

eventid

Yes

String

Event ID

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

total

Integer

Number of attack events

items

Array of ShowEventItems objects

Details about an attack event
Table 4 ShowEventItems

Parameter

Type

Description

time

Long

Count

policyid

String

Policy ID

sip

String

Source IP address

host

String

Domain name

url

String

Attacked URL

attack

String

Attack type

rule

String

ID of the matched rule

payload

String

Hit payload

action

String

Protective action

timestamp

Long

Timestamp

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code message

Status code: 500

Table 7 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