Help Center/ Host Security Service/ API Reference/ API Description/ Image Scan Task/ Modifying a Periodic Scan Policy
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Modifying a Periodic Scan Policy

Function

This API is used to modify a periodic scan 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

PUT /v5/{project_id}/image/scanner-policies

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

Request Parameters

Table 3 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

region

No

String

Definition

Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

enabled

Yes

Boolean

Scheduled Scan Policy Switch

scan_cycle

Yes

Integer

Scheduled scanning period | 3 Every three days 7 Every week 14 Every two weeks

scan_scope

Yes

Integer

Scanning risk type | 0: none; 0x7fffffff: all; 0x000f0000: vulnerability; 0x0000f000: baseline check; 0x00000f00: malicious file; 0x000000f0: sensitive information; 0x0000000f: software compliance

rate_limit

Yes

Integer

Scanning speed limit (unit: number/h | 0): not limited

time_scope

Yes

Integer

Time range unit: day | 0 All images 1 3 7

registry_info

Yes

Array of registry_info objects

Image repository list
Table 5 registry_info

Parameter

Mandatory

Type

Description

registry_id

Yes

String

Image repository ID.

registry_name

Yes

String

Image repository name.

registry_type

Yes

String

Image repository type | SwrPrivate: SWR private SwrShared: SWR shared SwrEnterprise: SWR enterprise Harbor: Harbor repository Jfrog: jfrog repository Other: other repositories

Response Parameters

Status code: 200

Policy modified.

None

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Policy modified.

Error Codes

See Error Codes.

Parent Topic: Image Scan Task