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.

SecurityBasicAuth

Request

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: Just a domain. site=example.com Domain with path. site=example.com/wordpress

Responses

200

HTTP Request was successful.

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

get/WordPressRestore/start

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --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

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
}
}