Skip to main content
POST
List Scans

Authorizations

Authorization
string
header
required

Get access to data with your API token. Example header:

Authorization: Bearer 2991e2fb4b540fe75b8f90677b0b892b6314e4961cb001fe6eb452eee248a628

The token can be provisioned from the Tokens section in your Settings, and requires explicitly enabling Web API access.

Path Parameters

deploymentId
string<int64>
required

The unique numerical identifier of your deployment. Can be found via the Deployments Service or in your Settings in the web UI.

Example:

"1234"

projectId
string<int64>
required

The unique numerical identifier for the project that was scanned. Can be found via the Projects Service, or in the Projects panel in the web UI.

Example:

"5678"

Body

application/json
cursor
string

Include the cursor from the previous response to paginate through the results

limit
integer<int64>

Number of scans to return per page. Default is 100, max is 500.

Example:

100

filters
List Scans Filter · object

Specify some or all of these optional filters to narrow down the results.

Response

200 - application/json

OK

scans
Scan · object[]

The list of scans.

cursor
string

Cursor to retrieve the next page of results.