Route: https://api.cytrix.io/GetQueue
Use this function to fetch and view all of your queued scans.
Roles Required: Admin and Users. Private Users can only View Scans they have created.
Request Syntax
{
“apiKey”: “string”,
“sort”: “string”,
“desc”: True/False
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your CYTRIX 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 :
sort
Parameter Usage and Options :
In case you want to fetch the queued scans in a specific order.
Value :
id|status|target|date
Type :
String
Is it Optional ? :
Yes.
Parameter Name :
desc
Parameter Usage and Options :
In case you want to fetch the queued scans in descending order.
Value :
True/False
Type :
Boolean
Is it Optional ? :
No – if you enable sort.
Successful Response
{
“Error”: 0,
“Function”: “GetQueue”,
“Data”: “[{\”token\”: \”String\”, \”url\”: \”URL\”, \”date\”: \”2022-05-30 01:23:45\”, \”status\”: \”enable\”}]”
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.