1. API Operations
  2. Stop scan

Deprecated

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

Stop scan

This operation stops a running scan.


Request

Parameters
Parameter
op
Type
string
required
true

Stop a scan. The value is "stop_scan".

Parameter
scan_id
Type
integer
required
true

The ID of the scan that will be stopped.

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. The value is "stopped".

Attribute
error
Type
string

Error message. Returned in case of a failed operation.

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