latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Account Restoration
Restore Queue Reporting

Return restoration tasks list

This function lists the tasks in the restoration queue.

get/restore_queue_state

Response

HTTP Request was successful.

Example response

{
  "data": {
    "active": [
      {
        "options": {
          "give_ip": 1,
          "mail_config": 1,
          "mysql": 1,
          "subdomains": 1
        },
        "restore_point": "2019-10-21T00:00:00.000Z",
        "user": "username"
      }
    ],
    "completed": [
      {
        "options": {
          "give_ip": 1,
          "mail_config": 0,
          "mysql": 1,
          "subdomains": 0
        },
        "restore_point": "2019-10-22T00:00:00.000Z",
        "user": "username"
      }
    ],
    "is_active": 1,
    "pending": [
      {
        "options": {
          "give_ip": 0,
          "mail_config": 1,
          "mysql": 0,
          "subdomains": 1
        },
        "restore_point": "2019-10-23T00:00:00.000Z",
        "user": "username"
      }
    ]
  },
  "metadata": {
    "command": "restore_queue_state",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}