Li, Qiao 901ea67b42 waf dedicated API 01

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>

2022-12-08 14:03:35 +00:00

12 KiB

Raw Blame History

Changing the Status of a Policy Rule

Function

This API is used to change the status of a policy 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
policy_id	Yes	String	Policy ID
ruletype	Yes	String	Rule type cc -custom whiteblackip privacy ignore geoip antitamper
rule_id	Yes	String	Rule ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User Token.
Content-Type	Yes	String	Content type Default: application/json;charset=utf8

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
status	No	Integer	Rule status. The value can be: 0: The rule is disabled. 1: The rule is enabled. Enumeration values: 0 1

Response Parameters

Status code: 400

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

Status code: 401

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

Status code: 500

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

Example Requests

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

{
  "status" : 0
}

Example Responses

Status code: 200

Request succeeded.

{
  "action" : {
    "category" : "block"
  },
  "action_mode" : false,
  "conditions" : [ {
    "category" : "header",
    "index" : "demo",
    "logic_operation" : "contain",
    "content" : [ "demo" ]
  } ],
  "description" : "",
  "id" : "2a3caa2bc9814c09ad73d02e3485b4a4",
  "policyid" : "1f016cde588646aca3fb19f277c44d03",
  "priority" : 50,
  "status" : 0,
  "time" : false,
  "timestamp" : 1656495488880
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Request failed.
401	The token does not have required permissions.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic: Rule Management

12 KiB Raw Blame History