1. API Operations
  2. Get scan status

Deprecated

You are viewing a deprecated version of our API Reference. Please visit the up-to-date documentation.

Get scan status

Returns the status of a scan by its ID.


Request

Parameters
Parameter
op
Type
string
required
true

Get the status of a scan. The value is "get_scan_status".

Parameter
scan_id
Type
integer
required
true

The ID of a scan belonging to the current user.

{
  "op": "get_scan_status",
  "scan_id": 27785
}

Response

Attributes
Attribute
op_status
Type
string

The status of the operation. The value can "success" or "fail".

Attribute
scan_status
Type
string

The status of the scan. Returned in case of a successful operation.

Attribute
error
Type
string

Error message. Returned in case of a failed operation.

{
  "op_status": "success",
  "scan_status": "running"
}