Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Scans

List Account's Scans

get/scans/

Query parameters

completed__gtstring date-time

Date and time from which scans completed (exclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

completed__gtestring date-time

Date and time from which scans completed (inclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

completed__ltstring date-time

Date and time until which the scans completed (exclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

completed__ltestring date-time

Date and time until which the scans completed (inclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

idstring[]

Identifiers of scans to filter results. Multiple choices are possible by repeating the query_param.

is_id_404_validationboolean

If true, triggers custom response for id filter validation.
If any id filter is invalid, returns a 404 with the following content:

{
    "detail": "Not Found",
    "is_id_404_validation": true,
    "invalid_ids": [
        "9vebyEVLNoZX",
        "6CuzJtJmMp48"
    ]
}
labelstring[]

A unique Base58 value identifying this object.

lengthinteger

Number of results to return per page.

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

partialboolean
scan_profilestring[]

Identifier of the scan profile to filter results.

searchstring

A search term.

started__gtstring date-time

Date and time from which the scans started (exclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

started__gtestring date-time

Date and time from which the scans started (inclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

started__ltstring date-time

Date and time from which the scans started (exclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

started__ltestring date-time

Date and time until which the scans started (inclusively) to filter results, in ISO 8601 UTC format.
For example, “2023-08-09T13:27:43.8208302".

started_afterstring date-time

Date and time of when the scan started to filter results, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302"

started_beforestring date-time

Date and time of when the scan started to filter results, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302"

statusstring[]

Status of the scan:

  • canceled - Canceled
  • canceling - Canceling
  • completed - Completed
  • completed_with_errors - Completed with errors - DEPRECATED
  • failed - Failed
  • paused - Paused
  • pausing - Pausing
  • queued - Queued
  • resuming - Resuming
  • started - Started
  • under_review - Under Review
  • finishing_up - Finishing up
targetstring[]

Scan target.

teamstring[]

A unique Base58 value identifying this object.

warningstring[]

Identifiers of warnings to filter results.
Multiple choices are possible by repeating the query_param.

Response

countinteger

Total number of results.

page_totalinteger

Total number of pages.

pageinteger

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

lengthinteger

Number of results returned per page.

Example response

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10
}