Creating a Known Attack Source Rule

Function

This API is used to create a known attack source rule.

URI

POST /v1/{project_id}/waf/policy/{policy_id}/punishment

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. In the displayed window, choose My Credentials. Then, in the Projects area, view Project ID of the corresponding project.
policy_id	Yes	String	Policy ID. It can be obtained by calling the ListPolicy API.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Content-Type	Yes	String	Content type. Default: application/json;charset=utf8

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
category	Yes	String	Type of the known attack source rule. Enumeration values: long_ip_block long_cookie_block long_params_block short_ip_block short_cookie_block short_params_block
block_time	Yes	Integer	Block duration. If prefix long is selected for the rule type, the value for block_time ranges from 301 to 1800. If prefix short is selected for the rule type, the value for block_time ranges from 0 to 300.
description	No	String	Rule description.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
id	String	Rule ID.
policyid	String	Policy ID.
block_time	Integer	Block duration.
category	String	Type of the known attack source rule.
description	String	Rule description.
timestamp	Long	Timestamp the rule is created.

Status code: 400

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

Status code: 401

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

Status code: 500

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

Example Requests

The following example shows how to create a known attack source rule in a policy. The project ID is specified by project_id and the policy ID is specified by policy_id. The rule type is long_ip_block, the block duration is 1233 seconds, and the rule description is demo.

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/punishment?

{
  "category" : "long_ip_block",
  "block_time" : "1233",
  "description" : "demo"
}

Example Responses

Status code: 200

Request sent.

{
  "block_time" : 1233,
  "category" : "long_ip_block",
  "description" : "demo",
  "id" : "2c3afdcc982b429da4f72ee483aece3e",
  "policyid" : "2fcbcb23ef0d48d99d24d7dcff00307d",
  "timestamp" : 1668148186106
}