Help Center/ Web Application Firewall/ API Reference/ APIs/ Policy and Rule Management/ Updating IP Intelligence Protection Rules
Updated on 2025-08-19 GMT+08:00

Updating IP Intelligence Protection Rules

Function

This API is used to update IP intelligence protection rules.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/waf/policy/{policy_id}/ip-reputation/{rule_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of the user.

Constraints

N/A

Range

N/A

Default Value

N/A

policy_id

Yes

String

Definition

Protection policy ID. You call the ListPolicy API and obtain the protection policy ID from the value of the id field in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A

rule_id

Yes

String

Definition

Rule ID. You can call the ListIdcIpRule API and obtain the rule ID from the id field in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS).

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header).

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Definition

Rule name.

Constraints

N/A

Range

N/A

Default Value

N/A

policyname

No

String

Definition

Policy name.

Constraints

N/A

Range

N/A

Default Value

N/A

description

No

String

Definition

Rule description.

Constraints

N/A

Range

N/A

Default Value

N/A

action

No

action object

Definition

Protective action configuration.

Constraints

N/A

Range

N/A

Default Value

N/A

type

No

String

Definition

Rule type, for example, idc indicates the data center IP intelligence type.

Constraints

N/A

Range

N/A

Default Value

N/A

tags

No

Array of strings

Definition

List of tags, which are associated intelligence IDs.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 5 action

Parameter

Mandatory

Type

Description

category

No

String

Definition

Action type (for example, captcha indicates the verification code).

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

id

String

Definition

Rule ID, which uniquely identifies a rule.

Constraints

N/A

Range

N/A

Default Value

N/A

policyid

String

Definition

Protection policy ID.

Constraints

N/A

Range

N/A

Default Value

N/A

name

String

Definition

Rule name.

Constraints

N/A

Range

N/A

Default Value

N/A

policyname

String

Definition

Policy name.

Constraints

N/A

Range

N/A

Default Value

N/A

timestamp

String

Definition

Rule update timestamp.

Constraints

N/A

Range

N/A

Default Value

N/A

description

String

Definition

Rule description.

Constraints

N/A

Range

N/A

Default Value

N/A

status

String

Definition

Rule status. 1: enabled. 0: disabled.

Constraints

N/A

Range

N/A

Default Value

N/A

action

action object

Definition

Protective action configuration.

Constraints

N/A

Range

N/A

Default Value

N/A

isp

String

Definition

ISP.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 7 action

Parameter

Type

Description

category

String

Definition

Action type, for example, log indicates that attacks are logged only.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 9 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 11 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 13 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/ip-reputation/{rule_id}?enterprise_project_id=0

{
  "name" : "name",
  "policyname" : "policy_name",
  "description" : "description",
  "action" : {
    "category" : "block"
  },
  "type" : "idc",
  "tags" : [ "AliCloud" ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "0b53a0cd878948e7a1875909076a0f7e",
  "policyid" : "6d392034d94c4e8a95a78c98127453b6",
  "name" : "name",
  "timestamp" : 1657798054082,
  "description" : "description",
  "status" : 1,
  "type" : "idc",
  "tags" : [ "AliCloud" ],
  "action" : {
    "category" : "log"
  }
}

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.