Updated on 2026-01-13 GMT+08:00

Modifying the Rule Status

Function

This API is used to modify the enabled or disabled status of a scan rule based on the specified template ID, rule ID, and project ID.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/scan-templates/{template_id}/scan-rules/{rule_id}/switch-status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used to identify a specific project.

rule_id

Yes

String

Rule ID, which is used to identify a specific scan rule.

template_id

Yes

String

Template ID, which is used to identify a specific scan template.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

is_used

Yes

Boolean

Whether to enable or disable the template rule.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

msg

String

Returned message, which is used to describe the operation result or status information.

status

String

Returned status, which indicates whether the operation is successful. For example, 200 indicates that the operation is successful, and 400 indicates that the request is invalid.

Status code: 201

Rule status updated.

Example Requests

PUT /v1/{project_id}/scan-templates/{template_id}/scan-rules/{rule_id}/switch-status

{
  "is_used" : true
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded. The operation result is returned.

201

Rule status updated.

401

Unauthorized. The user is not logged in or the token is invalid.

403

Unauthorized to access the resource.

404

The specified template or category is not found.

Error Codes

See Error Codes.