Updated on 2024-04-25 GMT+08:00

Changing the Status of a Rule

Function

This API is used to change the status of a single rule, for example, disabling a Precise Protection rule.

URI

PUT /v1/{project_id}/waf/policy/{policy_id}/{ruletype}/{rule_id}/status

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

Policy ID. It can be obtained by calling the API for querying the policy list.

ruletype

Yes

String

Policy Type

Enumeration values:

  • whiteblackip

  • geoip

  • privacy

  • antitamper

  • custom

  • ignore

  • cc

rule_id

Yes

String

Rule ID. It can be obtained by calling the specific API that is used to obtain the rule list of a certain type. For example, you can call the ListWhiteblackipRule API to obtain the ID of a blacklist or whitelist rule.

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

status

No

Integer

Status. The options are 0 and 1. 0: Disabled. 1: Enabled.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

Rule ID

policyid

String

Policy ID

timestamp

Long

Time when the rule was created.

description

String

Rule Description

status

Integer

Status. The options are 0 and 1. 0: Disabled. 1: Enabled.

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 change the protection status of a rule to disabled. Details about the rule are specified by project_id, policy_id, ruletype, and rule_id.

PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/{ruletype}/{rule_id}/status?enterprise_project_id=0

{
  "status" : 0
}

Example Responses

Status code: 200

OK

{
  "id" : "709bfd0d62a9410394ffa9e25eb82c36",
  "policyid" : "62fd7f8c36234a4ebedabc2ce451ed45",
  "timestamp" : 1650362797070,
  "description" : "demo",
  "status" : 0
}

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.