API Documentation

⌘K
  1. Home
  2. Docs
  3. API Documentation
  4. Queue
  5. EnableAllQueue

EnableAllQueue

Route: https://api.cytrix.io/EnableAllQueue

This function will enable the release of scans from the queue, after disabled was invoked.

Roles Required: Only Admin can disable/enable the whole queue.

Request Syntax

{

“apiKey”: “string”

}


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.


Successful Response

{

    “Error”: 0,

    “Function”: “EnableAllQueue”,

    “Data”: “Queue Enabled”

}

Errors and their Possible Causes

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