cPanel/WordPressBackup
cPanel module

WordPressBackup

6 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi
Call any function with cpanel_uapi(service_id, module="WordPressBackup", 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 all WordPress sites' backup status

This function checks for any active WordPress® site backups on the cPanel account.

Note:

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

No parameters.

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

any_runninginteger
Whether any backups are in progess. 1 - Backups are in progress. 0 - No backups are in progress.
One of: 0 1
sitesarray<object>
An array that contains each site with a backup in progress. The function only populates this array if it is actively processing a backup.
idstring
The WordPress site's unique ID. Note: null is the only possible value. We have not implemented this return.
sitestring
The WordPress site's URL. The URL does not contain a protocol prefix.
typestring
The type of process that is active. Note: backup is the only possible value.
sse_urlstring
The SSE service URL that the system uses to monitor the backup progress. The SSE service URL does not contain a protocol, hostname, or port.

cancel GET#

Stop WordPress site backup

This function cancels a WordPress® site backup.

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:

okinteger
Whether the system cancelled an active backup. 1 — Backup cancelled. 0 — Could not cancel the backup or no active backup in progress.
One of: 0 1
sitestring
The site's URL without the protocol prefix.

cleanup GET#

Delete WordPress backup temporary files

This function releases any system resources from a previous WordPress® site backup.

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:

okinteger
Whether the system released the system resources. 1 - Resources released. 0 - Backup in progress.
One of: 0 1
sitestring
The site's URL without the protocol prefix.

get_available_backups GET#

Return WordPress site backups

This function retrieves a list of available WordPress® site backups of a single site.

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:

availablearray<object>
An array of objects containing a list of the WordPress site's backups.
dateinteger
The date and time the system created the backup.
filestring
The backup's file name with the tar.zip extension.
pathstring
The absolute path to the backup file.
sitestring
The site's URL without the protocol prefix.
dirstring
The absolute path to the backup directory.

is_running GET#

Return WordPress site backup status

This function checks for an active WordPress® site backup.

Note:

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

sitestringRequired
The WordPress site's URL without http://.

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

action_idstring
The unique ID of the backup process.
is_runninginteger
Whether a backup is active. 1 - Backup in progress. 0 - No backup in progress.
One of: 0 1

start GET#

Backup WordPress site

This function starts a single WordPress® site backup.

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:

backup_idstring
The unique ID of the backup process.
sitestring
The WordPress site's URL without the protocol prefix.
sse_urlstring
The SSE path without the protocol, hostname, or port that the system uses to monitor the backup progress.