Help Center/ Cloud Firewall/ API Reference (Kuala Lumpur Region)/ API/ IPS Management/ Updating a Frequency IPS Rule
Updated on 2025-11-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Updating a Frequency IPS Rule

Function

This API is used to update a frequency IPS rule.

URI

POST /v1/{project_id}/advanced-ips-rule

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained by calling an API or from the console. You can obtain it by referring to Obtaining a Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

fw_instance_id

No

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

enterprise_project_id

No

String

Enterprise project ID, which is the ID of a project planned based on organizations. If the enterprise project function is not enabled, the value is 0.

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).
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

action

No

Integer

Action: 0 (only record logs), 1 (block sessions), 2 (block IP addresses).

ips_rule_id

No

String

Advanced IPS rule ID.

ips_rule_type

No

Integer

IPS rule type: 0 (sensitive directory scan), or 1 (reverse Xshell).

object_id

No

String

Protected object ID.

param

No

String

JSON string containing special parameters.

status

No

Integer

Frequency-based IPS rule status: 0 (disabled), 1 (enabled).

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

data

ResponseData object

Common response body.
Table 6 ResponseData

Parameter

Type

Description

id

String

Data ID.

Status code: 201

Created

Example Requests

Change the reverse shell detection configuration to Observe | Conservative.

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/advanced-ips-rule?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4

{
  "ips_rule_id" : "7d453586-524f-4a1d-a827-34d80389378f",
  "ips_rule_type" : 0,
  "action" : 0,
  "param" : "{\"mode\":0}",
  "status" : 1,
  "object_id" : "1b90f031-0c7b-4f25-95e2-b6d9940d269e"
}

Example Responses

Status code: 200

OK

{
  "data" : {
    "id" : "7d453586-524f-4a1d-a827-34d80389378f"
  }
}

Status Codes

Status Code

Description

200

OK

201

Created

401

Unauthorized: Request error.

403

Forbidden: Access forbidden.

404

Not Found: Web page not found.

Error Codes

See Error Codes.

Parent topic: IPS Management