Get List of Scan Jobs

get

https://{hostname}/api/discovery-scan-config/v2/scan-job/datasource/{dataSourceId}

Use this API to retrieve a list of all scan jobs in JSON format for the specified data source. The response will include relevant details for each scan job, including the corresponding scan job ID, created date, and cancelled date.

Path Params

dataSourceId

uuid

required

The unique identifier of the data source.

Query Params

status

array of strings

Status of the job scan

status

scanLevel

array of strings

Array of scan levels

scanLevel

isManual

boolean

The flag to check if the retrieved jobs are Manual or Scheduled

createdFrom

date-time

The date (yyyy-mm-dd) to filter the scan jobs created on or after the specified date. For example, including the parameter createdFrom=2022-06-06 will filter results to scan jobs on or after June 6th, 2022.

createdTo

date-time

The date (yyyy-mm-dd) to filter the scan jobs created on or before the specified date. For example, including the parameter createdTo=2022-06-06 would filter results to scan jobs on or before June 6th, 2022.

page

int32

≥ 0

Defaults to 0

Results page to be retrieved (0..N).

size

int32

1 to 50

Defaults to 20

Number of records per page (1..50). Maximum page size allowed is 50

sort

string

enum

Defaults to createdDate,desc

Sorting criteria in the format: property(,asc|desc). Default is ascending.

Allowed:

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200List of scan jobs

429Too Many Requests. For more information, see API Rate Limits.