Child pages
  • WHM API 1 Functions - restore_queue_is_active
Skip to end of metadata
Go to start of metadata

 

Description

This function checks whether the system's restoration queue is actively processing tasks.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_is_active?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/restore_queue_is_active?api.version=1
 Command Line
whmapi1 restore_queue_is_active


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
    "data": {
        "is_active": 0
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": "1",
        "command": "restore_queue_is_active"
    }
}
 Output (XML)
<result>
    <data>
        <is_active>0</is_active>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>restore_queue_is_active</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
is_activeBooleanWhether the restoration queue is actively processing tasks.
  • 1 — Currently active.
  • 0Not currently active.
1