Creating a Task for Exporting Handled Vulnerabilities

Function

This API is used to create a task for exporting handled vulnerabilities.

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}/vulnerability/history/export-task

**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
vul_name	No	String	Vulnerability name.
repair_priority	No	String	Vulnerability fixing priority. The options are as follows: Critical High Medium Low**
host_name	No	String	Server name.
host_ip	No	String	Server IP address.
is_affect_business	No	Boolean	Whether services are affected.
status	No	String	Vulnerability status. vul_status_unfix: not fixed vul_status_ignored: ignored vul_status_verified: verification in progress vul_status_fixing: fixing vul_status_fixed: fixed vul_status_reboot: Fixed and pending restart vul_status_failed: fix failed vul_status_fix_after_reboot: Restart the server and try again.
asset_value	No	String	Asset importance. important common test
label	No	String	Vulnerability tag.
type	No	String	Vulnerability type. The options are as follows: linux_vul: Linux vulnerability windows_vul: windows vulnerability web_cms: Web-CMS vulnerability app_vul: application vulnerability urgent_vul: emergency vulnerability
group_name	No	String	Server group name.
handle_cycle	No	String	Vulnerability handling period. The options are as follows: today: Query the data handled today. all: Query all handled data.
specific_vuls	No	Array of specific_vuls objects	Vulnerability data to be exported.
export_size	No	Integer	Number of exported data records.
export_headers	Yes	Array<Array<String>>	Header list of exported vulnerability data.

**Table 5** specific_vuls
Parameter	Mandatory	Type	Description
host_id	No	String	Server ID.
vul_id	No	String	Vulnerability ID.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
task_id	String	Task ID.

Example Requests

Export all the handled Linux vulnerabilities in the project whose project_id is 2b31ed520xxxxxxebedb6e57xxxxxxxx. The exported Excel file contains the Vulnerability Name column.

POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/history/export-task?enterprise_project_id=all_granted_eps

{
  "type" : "linux_vul",
  "handle_cycle" : "all",
  "export_headers" : [ [ "vul_name", "Vulnerability name." ] ]
}