ESescape
Scans

List scans

List and search scans of the organization.

get/scans

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Query parameters

cursorstring

The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.

Example:R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5
sizeinteger

The number of items to return per page

Example:50
sortType'SEVERITY' | 'createdAt'

The type to sort by

sortDirection'asc' | 'desc'

The direction to sort by

afterstring

Filter by after date

Example:2025-03-15T09:00:00Z
beforestring

Filter by before date

Example:2025-03-15T09:00:00Z
searchstring

Search term to filter scans

Example:scan
string
OR
string[]
string
OR
string[]
string
OR
string[]
assetTypesstring[]

Filter by asset types

ignored'true' | 'false'

Filter by ignored status

Example:true
initiatorstring[]

Filter by initiator

kindsstring[]

Filter by kind

statusstring[]

Filter by status

string
OR
string[]
problemCodesstring[]

Filter by problem codes

problemSeveritiesstring[]

Filter by problem severities

noTags'true' | 'false'

Filter by assets with no tags

Example:true
commitBranchstring

Filter by commit branch. Not supported by the GraphQL where input, so it is applied after fetching.

latestBranchScans'true' | 'false'

Keep only the latest scan of each commit branch. Not supported by the GraphQL where input, so it is applied after fetching.

Example:true
dnfstring

Filter by DNF expression

Response

OK

nextCursorstring nullable required
totalCountinteger

Example response

{
  "totalCount": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.