Modifying Scheduled Security Check Configuration

Function

This API is used to modify the scheduled configuration of a security check.

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}/security-check/config

**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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
task_id	No	Long	Scheduled task ID, which is saved but not displayed on the GUI.
status	No	Boolean	Health check status, whether to enable the chack
check_period_type	No	String	Health check period type. The options are day and week.
day_period	No	Integer	Period by day
week_period	No	Array of strings	Weekly period. The selected date is added to this list. The options are mon, tue, wed, thu, fri, sat, and sun.
hour	No	Integer	Health check duration: hour
content	No	Array of strings	Health check content. The value can be asset, vul, baseline, or event.
host_id_list	No	Array of strings	Selected Server IDs
operate_all	No	Boolean	Indicates whether to select all servers. Selecting all servers is irrelevant to the search criteria.

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

{
  "task_id" : 1,
  "status" : true,
  "check_period_type" : "week",
  "week_period" : [ "mon", "tue" ],
  "hour" : 1,
  "content" : [ "asset", "vul", "baseline", "event" ],
  "host_id_list" : [ "host1", "host2" ]
}