Updated on 2025-10-29 GMT+08:00

Exporting Vulnerabilities

Function

This API is used to export vulnerability details.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/vulnerability/export

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

data_object_filters_form

No

VulDataobjectSearch object

Search criteria.

title

No

Array of strings

Exported fields.

Table 3 VulDataobjectSearch

Parameter

Mandatory

Type

Description

limit

No

Integer

The number of records on each page.

offset

No

Integer

Offset.

sort_by

No

String

Sorting field: create_time | update_time.

order

No

String

Sorting order. Options: DESC and ASC.

from_date

No

String

Search start time, for example, 2023-02-20T00:00:00.000Z.

to_date

No

String

Search end time, for example, 2023-02-27T23:59:59.999Z.

condition

No

condition object

Search condition expression.

Table 4 condition

Parameter

Mandatory

Type

Description

conditions

No

Array of conditions objects

Expression list.

logics

No

Array of strings

Expression name list.

Table 5 conditions

Parameter

Mandatory

Type

Description

name

No

String

Expression name.

data

No

Array of strings

Expression content list.

Response Parameters

Status code: 200

Exported vulnerability list.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Exported vulnerability list.

400

Body of the response for failed requests for exporting vulnerabilities.

Error Codes

See Error Codes.