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

 

Description

This function lists the tasks that the restoration queue is actively processing.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/restore_queue_list_active?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/restore_queue_list_active?api.version=1
 Command Line
whmapi1 restore_queue_list_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":{  
      "restore_job":[  
         {  
            "options":{  
               "give_ip":0,
               "mysql":1,
               "subdomains":1,
               "mail_config":1
            },
            "restore_point":"2015-10-21",
            "user":"user"
         }
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"restore_queue_list_active"
   }
}
 Output (XML)
<result>
    <data>
        <restore_job>
            <options>
                <give_ip>0</give_ip>
                <mysql>1</mysql>
                <subdomains>1</subdomains>
                <mail_config>1</mail_config>
            </options>
            <restore_point>2015-10-21</restore_point>
            <user>example</user>
        </restore_job>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>restore_queue_list_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

restore_job

array of hashesAn array of hashes that contain information about an active task in the restoration queue.This hash includes the user and restore_point returns and the options hash. 

options

hash

A hash of information about an active task in the restoration queue.

The function returns this value in the retore_job hash.

This hash includes the give_ip, mysql, subdomains, and mail_config returns.

 

give_ip

Boolean

Whether the task will assign the account a dedicated IP address.

The function returns this value in the options hash.

  • 1 — Assign.
  • 0 — Will not assign.
1

mysql

Boolean

Whether the task will restore the account's MySQL® databases.

The function returns this value in the options hash.

  • 1 — Restore.
  • 0 — Will not restore.
1

subdomains

Boolean

Whether the function will restore the account's subdomains.

The function returns this value in the options hash.

  • 1 — Restore.
  • 0 — Will not restore.
1

mail_config

Boolean

Whether the function will restore the account's email configuration.

The function returns this value in the options hash.

  • 1 — Restore.
  • 0 — Will not restore.
1

user

string

The cPanel account's username.

The function returns this value in the restore_job hash.

A valid cPanel username.username

restore_point

string

The date of the backup that the task will use.

The function returns this value in the restore_job hash.

A backup creation date, where:

  • YYYY represents the year.
  • MM represents the month.
  • DD represents the date.
2015-10-21