---
title: "Return restoration tasks list"
method: GET
path: "/restore_queue_state"
tags: ["Account Restoration", "Restore Queue Reporting"]
---

# Return restoration tasks list

`GET /restore_queue_state`

This function lists the tasks in the restoration queue.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `active` RestorePoint[] — An array of objects containing restoration queue items that the system is actively processing.
      - `options` object
        - `give_ip` 1 | 0 — Whether the restoration process will assign a dedicated IP address to the account. * `1` — Will assign. * `0` — Will **not** assign.
        - `mail_config` 1 | 0 — Whether the restoration process will restore the account's email configuration. * `1` — Will restore. * `0` — Will **not** restore.
        - `mysql` 1 | 0 — Whether the restoration process will restore the account's MySQL® databases. * `1` — Will restore. * `0` — Will **not** restore.
        - `subdomains` 1 | 0 — Whether the restoration process will restore the account's subdomains. * `1` — Will restore. * `0` — Will **not** restore.
      - `restore_point` string, ISO-8601 Date — The date of the backup file.
      - `user` string, username — The cPanel account's username.
    - `completed` RestorePoint[] — An array of objects containing restoration queue items that the system has already processed.
      - `options` object
        - `give_ip` 1 | 0 — Whether the restoration process will assign a dedicated IP address to the account. * `1` — Will assign. * `0` — Will **not** assign.
        - `mail_config` 1 | 0 — Whether the restoration process will restore the account's email configuration. * `1` — Will restore. * `0` — Will **not** restore.
        - `mysql` 1 | 0 — Whether the restoration process will restore the account's MySQL® databases. * `1` — Will restore. * `0` — Will **not** restore.
        - `subdomains` 1 | 0 — Whether the restoration process will restore the account's subdomains. * `1` — Will restore. * `0` — Will **not** restore.
      - `restore_point` string, ISO-8601 Date — The date of the backup file.
      - `user` string, username — The cPanel account's username.
    - `is_active` 0 | 1 — Whether the restoration queue is actively processing a task. * `1` — The restoration queue is processing a task. * `0` — The restoration queue is **not** processing a task.
    - `pending` RestorePoint[] — An array of objects containing restoration queue items that the system will process next.
      - `options` object
        - `give_ip` 1 | 0 — Whether the restoration process will assign a dedicated IP address to the account. * `1` — Will assign. * `0` — Will **not** assign.
        - `mail_config` 1 | 0 — Whether the restoration process will restore the account's email configuration. * `1` — Will restore. * `0` — Will **not** restore.
        - `mysql` 1 | 0 — Whether the restoration process will restore the account's MySQL® databases. * `1` — Will restore. * `0` — Will **not** restore.
        - `subdomains` 1 | 0 — Whether the restoration process will restore the account's subdomains. * `1` — Will restore. * `0` — Will **not** restore.
      - `restore_point` string, ISO-8601 Date — The date of the backup file.
      - `user` string, username — The cPanel account's username.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)