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.

Authorizations:
query Parameters
backup_path
required
string <path>

The file path to the backup archive.

Example: backup_path=/home/example/wordpress-backups/example.com__2018-11-13T11:11:31-0600.tar.gz
site
required
string

The WordPress site's URL to restore.

Examples:
site=example.com
site=example.com/wordpress

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username WordPressRestore start site='example.com' backup_path='/home/example/wordpress-backups/example.com__2018-11-13T11:11:31-0600.tar.gz'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "start",
  • "module": "WordPressRestore",
  • "result": {
    • "data": {
      • "restore_id": "example.com__2018-11-15T08:03:22-0600"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}