• Web Application Firewall

waf
  1. Help Center
  2. Web Application Firewall
  3. API Reference
  4. APIs
  5. Obtaining Option Details
  6. Querying Event Type in Alarm Notifications

Querying Event Type in Alarm Notifications

Function Description

This API is used to query event type in an alarm notification.

URI

  • URI format

    GET /v1/{project_id}/waf/map/threat?lang={lang}

  • Parameter description
    Table 1 Path parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Specifies the project ID.

    lang

    No

    String

    Specifies the language configuration. The options are zh-cn and en-us. The default value is en-us.

Request

Request parameters

None

Response

Response parameters
Table 2 Parameter description

Parameter

Type

Description

threats

List

Specifies the list of event types.

locale

Table 3

Specifies event names.

Table 3 locale

Parameter

Type

Description

xss

String

Specifies XSS attack.

sqli

String

Specifies SQL injection.

cmdi

String

Specifies command injection.

cc

String

Specifies CC attack.

custom_custom

String

Specifies Precise Protection.

illegal

String

Specifies invalid requests.

lfi

String

Specifies local file inclusion.

robot

String

Specifies malicious crawlers.

antitamper

String

Specifies Web Tamper Protection.

rfi

String

Specifies remote file inclusion.

vuln

String

Specifies other types of attacks.

custom_whiteblackip

String

Specifies Blacklist and Whitelist.

webshell

String

Specifies webshells.

Example

Response example
{
  "threats": ["xss", "sqli", "cmdi"],
  "locale": {
       "xss":  "Cross Site Scripting",
       "sqli": "SQL Injection",
       "cmdi": "Command Injection"
   }
}

Status Code

Table 4 describes the normal status code returned by the API.
Table 4 Status code

Status Code

Description

Meaning

200

OK

The request has succeeded.

For details about error status codes, see Status Codes.