1. Home
  2. Docs
  3. API Documentation
  4. Scans
  5. StopScan

StopScan

This function will allow you to stop scans in the process.

Note : only incomplete scans can be stopped.

Request Syntax

{

"apiKey": "string",

"token": "String"

}


Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your Kayran given API Key.

How do I get it ? :

Located in the “Profile” section.

Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.

Type :

String

Is it Optional ? :

No.


Parameter Name :

token

Parameter Usage and Options :

The scan’s token.

How do I get it ? :

Simply use the “GetScan” or “GetAllScans” function, or navigate to a certain scan’s page, and in the address bar, you will notice “token=String”, use that String.

Type :

String

Is it Optional ? :

No.


Successful Response

{
“Error”: 0,
“Function”: “StopScan”,
“Data”: “Stopped
}

Errors and their Possible Causes

{    “Error”: 1,    “Function”: “StopScan”,    “Data”: “scan must be in progress”} – you can’t stop a scan that is not in progress.

For more information, please refer to the General Errors section.