v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

WordPressRestore

WordPress Manager Backups

Restore WordPress site

This function starts a single WordPress® site backup restoration.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

get/WordPressRestore/start

Query parameters

backup_pathstring path required

Example:/home/example/wordpress-backups/example.com__2018-11-13T11:11:31-0600.tar.gz

The file path to the backup archive.

sitestring required

The WordPress site's URL to restore.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "start",
  "module": "WordPressRestore",
  "result": {
    "data": {
      "restore_id": "example.com__2018-11-15T08:03:22-0600"
    },
    "status": 1
  }
}