cPanel module

WordPressRestore

3 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi

Call any function with cpanel_uapi(service_id, module="WordPressRestore", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

any_running GET#

Return WordPress site restore status

This function returns whether a WordPress® site backup restoration is in progress.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.
The output of this function changes, depending on the state of the backup restoration.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

itemsany

cleanup GET#

Delete restored WordPress site's temporary files

This function cleans up any temporary system resources after a WordPress® site backup restoration.

Note:

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

sitestringRequired

The WordPress site's URL without the protocol prefix.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Whether the system cleaned up the temporary system resources. 1 - Successful. 0 - Unsuccessful.

start GET#

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.

backup_pathstringRequired

The file path to the backup archive.

sitestringRequired

The WordPress site's URL to restore.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

restore_idstring

The unique identifier for the restoration operation. The name of the backup file without the file extension.