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

ChangeSpeed

This feature will allow you to change the speed of an active, desired scan.

Note : we recommend initiating and leaving the “Auto Speed” option enabled, but, it is not mandatory.

Request Syntax

{

"apiKey": "string",

"token": "String",

"speed": 10

}


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.


Parameter Name :

speed

Parameter Usage and Options :

Setting Kayran scan speed, changing the value of the speed parameter will cause Kayran to change the number of RPS (Requests Per Second).
Note : if you determine that the value of autoSpeed is “on”, the speed will be set automatically and dynamically.

Value :

Ranges from 1 to 10.

1 – Lowest Speed

10 – Highest Speed

Type :

Integer

Is it Optional ? :

Yes.


Successful Response

{
“Error”: 1,
“Function”: “ChangeSpeed”,
“Data”: “Changed, status: In Progress”
}

Errors and their Possible Causes

{    “Error”: 1,    “Function”: “ChangeSpeed”,    “Data”: “Target not in progress, status: Completed”} – you can only change the speed of scans that are “In Progress”.

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