---
title: "Restore one cPanel account from a backup"
method: GET
path: "/start_local_cpmove_restore"
tags: ["Backups", "Backup or Restore"]
---

# Restore one cPanel account from a backup

`GET /start_local_cpmove_restore`

This function performs a full restoration of a single cPanel account from a `cpmove` tarball.

## Query parameters

- `cpmovepath` string, required
- `dedicated_ip` 0 | 1
- `delete_archive` 0 | 1
- `mail_location` union
  - '.local' | '.existing'
  - string — The remote cPanel & WHM linked server node's alias.
- `overwrite` 0 | 1
- `restricted` 0 | 1
- `update_a_records` 'all' | 'basic'
- `username` string, username

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `transfer_session_id` string — The background transfer process ID.
  - `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)