Route: https://kayran.live/api/DisableQueue
This function allows you to disable scans in your queue.
Note : doing so, won’t delete the scan, you can enable it later on.
Roles Required: Admin. Users and Private Users can only Disable Scans they have created.
Request Syntax
{
“apiKey”: “string”,
“token”: “String”,
“tokens”: [“String”, “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.
Parameter Name :
tokens
Parameter Usage and Options :
Same as “token”, only for cases you wish to disable a number of queued scans.
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 ? :
Yes\No – depends on whether you wish to address a number of scans.
Successful Response
{
“Error”: 0,
“Function”: “DisableQueue”,
“Data”: {
“token”: “String”,
“code”: 0,
“info”: “Status Update to disable”
}
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.
