Help Center/ Host Security Service/ API Reference/ API Description/ Protection configuration/ Enabling or Disabling a Policy, Only CN Southwest-Guiyang1 Is Supported
Updated on 2026-09-24 GMT+08:00

Enabling or Disabling a Policy, Only CN Southwest-Guiyang1 Is Supported

Function

This API is used to enable or disable a policy.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v5/{project_id}/ai/policy/operate

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which can be obtained from My Credentials.

Constraints

Mandatory

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

enabled

Yes

Boolean

Definition

Whether to enable

Constraints

Mandatory

Range

  • false: no

  • true: yes

Default Value

N/A

policy_id

Yes

String

Definition

Policy ID.

Constraints

Mandatory

Range

The value can contain 1 to 20 characters.

Default Value

N/A

Response Parameters

Status code: 200

None

Example Requests

Enable/disable policy

POST https://{endpoint}/v5/{project_id}/ai/policy/operate

{
  "policy_id" : "2058116443483586560",
  "enabled" : true
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.