Updated on 2025-09-08 GMT+08:00

Enabling or Disabling a Policy

Function

This API is used to enable or disable a policy.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{domain_id}/tenant/open-source/rule-sets/{rule_set_id}/switch

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

rule_set_id

Yes

String

Definition:

Policy ID, which is the unique identifier of a policy. Obtain the policy ID by calling the API for querying policies. data.id indicates the policy ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

domain_id

Yes

String

Definition:

Tenant ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

is_valid

Yes

Boolean

Definition:

Rule template instance status.

Constraints:

N/A

Value range:

  • true: enabled.

  • false: disabled.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

Boolean

Definition:

Whether the update is successful.

Value range:

  • true: The update is successful.

  • false: The update fails.

rule_set_id

String

Definition:

ID of the updated policy.

Value range:

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.