Return completed restoration tasks list

This function lists the restoration queue's completed tasks.

Important:

This function's output varies dramatically. The /usr/local/cpanel/bin/backup_restore_manager script run with the list_finished option determines this output..

Note:

On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.

  • This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
  • Red Hat 7.1 and CentOS 7.1 both contain bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the Red Hat Bugzilla case about SPF record errors.
SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/restore_queue_list_completed
Request samples
whmapi1 --output=jsonpretty \
  restore_queue_list_completed
Response samples
application/json

A task that the restore_queue_add_task function added.

{
  • "data": {
    • "restore_job": [
      • {
        • "restore_job": {
          • "options": {
            • "destid": "local",
            • "give_ip": 0,
            • "mail_config": 0,
            • "mysql": 0,
            • "subdomains": 0
            },
          • "restore_point": "2020-03-29T00:00:00.000Z",
          • "user": "mrfrog"
          },
        • "status_info": {
          • "altered_items": null,
          • "dangerous_items": null,
          • "finished": "1586188203",
          • "log": "warning",
          • "restore_logfile": "item-RESTORE_AccountLocal_mrfrog",
          • "result": 2,
          • "skipped_items": null,
          • "started": "1586188078",
          • "status": 2,
          • "statusmsg": "warning",
          • "transfer_session_id": "userbackup20200406154758JqBa",
          • "warnings": null
          }
        }
      ]
    },
  • "metadata": {
    • "command": "restore_queue_list_completed",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}