Route: https://api.cytrix.io/TargetPause
This function will allow you to pause an existing scan.
Roles Required: Admin. Private Users and Users can only Pause Scans they initiated.
Request Syntax
{
"apiKey": "string",
"tokens": "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 tokens.
“token”, “token”, “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": "TargetPause",
"Data": "Target Pause" / "Paused 2/2 Targets"
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.