Skip to main content
GET
List scans

Authorizations

Authorization
string
header
required

Bearer API Key. For example, "Bearer {Tenant API Key}"

Headers

Authorization
string
required

Bearer API Key. For example, "Bearer {Tenant API Key}"

Content-Type
string

application/json

Query Parameters

ids
string

Filter scans based on ids. Accepts a comma-separated list of ids.

Example:
artifactNames
string

Filter scans based on artifact name. Accepts a comma-separated list of artifact names.

Example:

"my-iac.zip,my-iac2.zip"

statuses
enum<string>

Filter scans based on status. Accepts a comma-separated list of statuses.

Available options:
SUCCESS,
FAILURE
Example:

"SUCCESS"

sortBy
enum<string>

Sort results by the specified field.

Available options:
id,
createdAt,
updatedAt,
artifactName,
status
Example:

"createdAt"

sortOrder
enum<string>

Sort order for the results.

Available options:
asc,
desc
Example:

"asc"

page
integer

Page number for the results. Accepts a positive integer.

Example:

1

perPage
integer

Number of results per page. Accepts a positive integer.

Example:

10

Response

OK

data
object[]
meta
object