Help Center/ Web Application Firewall/ API Reference/ APIs/ Rule Management/ Updating a JavaScript Anti-Crawler Protection Rule
Updated on 2024-04-25 GMT+08:00
View PDF

Updating a JavaScript Anti-Crawler Protection Rule

Function

This API is used to update the protection mode for a JavaScript anti-crawler rule. Before creating a JavaScript anti-crawler rule, you need to call this API to specify the protection mode for the rule.

URI

PUT /v1/{project_id}/waf/policy/{policy_id}/anticrawler

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. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project.

policy_id

Yes

String

ID of a protection policy. You can specify a protection policy ID to query the rules used in the protection policy. You can obtain the policy ID 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

anticrawler_type

Yes

String

JavaScript anti-crawler rule type.

  • anticrawler_specific_url: used to protect a specific path specified by the rule.

  • anticrawler_except_url: used to protect all paths except the one specified by the rule.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

anticrawler_type

String

JavaScript anti-crawler rule type.

  • anticrawler_specific_url: used to protect a specific path specified by the rule.

  • anticrawler_except_url: used to protect all paths except the one specified by the rule.

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 update a JavaScript-based anti-crawler rule in a policy. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id. The rule type is changed to excluding protection paths.

PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/anticrawler?

{
  "anticrawler_type" : "anticrawler_except_url"
}

Example Responses

Status code: 200

ok

{
  "anticrawler_type" : "anticrawler_except_url"
}

Status Codes

Status Code

Description

200

ok

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.

Parent topic: Rule Management