---
title: "Return backup modules list"
method: GET
path: "/restore_modules_summary"
tags: ["Account Restoration", "Restore Queue Reporting"]
---

# Return backup modules list

`GET /restore_modules_summary`

This function lists backup modules and their descriptions.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `modules` object[] — An array of objects containing information about backup configuration modules.
      - `module` string — The module's name.
      - `notes` string[] — Notes about the module, if any exist.
      - `restricted_available` 1 | 0 — Whether the module is available under a [restricted restore](https://go.cpanel.net/whmdocsTransferorRestoreacPanelAccount#restricted-restore). * `1` — The module is available under a restricted restore. * `0` — The module is **not** available under a restricted restore.
      - `restricted_summary` string[] — A description of the module's behavior when the transfer uses a restricted restore.
      - `summary` string[] — A description of the module's behavior when the transfer does **not** use a restricted restore.
  - `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` 1 | 0 — * `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)