Enabling or Disabling a Risk Rule

This API is used to enable or disable risk rules.

For details, see Calling APIs.

POST /v1/{project_id}/{instance_id}/audit/rule/risk/switch

**Table 1** URI parameter
Parameter	Mandatory	Parameter Type	Description
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID. You can obtain the value from the ID field in the API for querying the instance list.

**Table 2** Request header parameter
Parameter	Mandatory	Parameter 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 3** Request body parameter
Parameter	Mandatory	Parameter Type	Description
ids	Yes	String	Rule ID. Use commas (,) to separate multiple IDs. You can obtain the value from the ID field in the API for querying risk rule policies.
status	Yes	String	Switch status OFF: disabled ON: enabled

Status code: 200

**Table 4** Response body parameter
Parameter	Parameter Type	Description
status	String	Response status

Status code: 400

**Table 5** Response body parameter
Parameter	Parameter Type	Description
error	Object	Error message.

**Table 6** ErrorDetail
Parameter	Parameter Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 403

**Table 7** Response body parameter
Parameter	Parameter Type	Description
error	Object	Error message.

**Table 8** ErrorDetail
Parameter	Parameter Type	Description
error_code	String	Error code
error_msg	String	Error message

/v1/{project_id}/{instance_id}/audit/rule/risk/switch

{
  "ids" : "c7ILB3kBCwCqSg3B2OpF",
  "status" : "OFF"
}

Example response with status code 200:

The request has succeeded.

{
  "status" : "SUCCESS"
}

Status code: 400

Invalid request parameters.

{
  "error" : {
    "error_code" : "DBSS.XXX",
    "error_msg" : "XXX"
  }
}

Status code: 403

Authentication failed.

{
  "error" : {
    "error_code" : "DBSS.XXX",
    "error_msg" : "XXX"
  }
}

For details, see Error Codes.

Parent topic: Audit Rules

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.