Get scan.

GET

/backend/v1/scans/{scanRequestId}

Retrieves a scan request by its ID.

Authorizations

HTTPBearer

TypeHTTP (bearer)

Parameters

Path Parameters

scanRequestId*

Typestring

Required

formatuuid

Responses

Successful Response

Content-Type

application/json

{

"scan": {

"externalMetadata": "string",

"id": "string",

"input": "string",

"preserve": false,

"projectId": "string",

"receivedAt": "string",

"result": {

"outcome": "string",

"scannerResults": [

{

"completedDate": "string",

"customConfig": false,

"data": {

"matches": [

[

]

],

"type": "regex"

},

"outcome": "string",

"scanDirection": "string",

"scannerId": "string",

"scannerVersionMeta": "string",

"startedDate": "string"

}

]

},

"type": "scan",

"userId": "string"

}

}

GET

/backend/v1/scans/{scanRequestId}

Playground

Authorization

HTTPBearer

Variables

Key

Value

scanRequestId*

Samples

Powered by VitePress OpenAPI