Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Scan Jobs

Get List of Scan Jobs

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.

get/api/discovery-scan-config/v2/scan-job/datasource/{dataSourceId}

Path parameters

dataSourceIdstring uuid required

The unique identifier of the data source.

Query parameters

statusstring[]

Status of the job scan

scanLevelstring[]

Array of scan levels

isManualboolean

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

createdFromstring 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.

createdTostring 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.

pageinteger

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

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

sizeinteger

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

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

sort'status,asc' | 'status,desc' | 'scanLevel,asc' | 'scanLevel,desc' | 'createdDate,asc' | 'createdDate,desc'

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

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

Response

List of scan jobs

numberinteger

Current page number.

sizeinteger

The size of the page (number of elements per page).

numberOfElementsinteger

The number of elements on the current page.

totalElementsinteger

The total number of elements across all pages.

totalPagesinteger

The total number of pages.

firstboolean

Indicates if this is the first page.

lastboolean

Indicates if this is the last page.

emptyboolean

Indicates if the page is empty.

Example response

{
  "content": [
    {
      "id": 1,
      "name": "Item"
    }
  ],
  "size": 20,
  "numberOfElements": 15,
  "totalElements": 150,
  "totalPages": 8,
  "first": true
}