Skip to content

Get scan

GET
/scans/{scanId}

Get scan by ID

scanId
required
integer

ID of the scan to be returned

Successfully retrieved scan

object
data
Scan

Object representing a scan

object
id

Internal scan ID

integer
createdAt

Date of scan creation

date
updatedAt

Date of scan update (can be null)

date
finishedAt

Date/time the scan finished

date
sequenceType

The sequence type of scan (initial, manual, monitoring etc)

string
nbIssues

Issue count (recursive warns + recursive fails). Null until scan is finished and analyzed

integer
tests

Array[CheckResult]. All checks within this scan (only for finished scans and with include_checks=true). Will not be returned in monitoring context, see monitoring_alerts below.

array
processingStatus

The processing status of a scan. One from the list: queued, processing, finished, failed, cancelled

string

401 Authentication failed

401 Authentication failed response

Unable to authenticate user

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

403 Forbidden

403 Forbidden response

Currently authenticated user does not have permission to access or update requested object

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

404 Not found

404 Not found response

Requested resource or underlying resource was not found

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

422 Unprocessable entity

422 Unprocessable entity

There is something wrong with the content of the request, typically missing or improperly formatted fields

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string