Description

This function checks for an active WordPress® site backup.


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


Examples 




https://hostname.example.com:2083/cpsess##########/execute/WordPressBackup/is_running?site=example.com



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Check for an active WordPress site backup.
 $instances = $cpanel->uapi(
    'WordPressBackup', 'is_running',
	array(	
		'site' => 'example.com'
	)
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Check for an active WordPress site backup.
my $instances = $cpliveapi->uapi(
    'WordPressBackup', 'is_running',
	{
		'site' => 'example.com'
	}
);



<!-- Check for an active WordPress site backup. -->
[% data = execute( 'WordPressBackup', 'is_running', { 'site' => 'example.com' } ); %]



uapi --user=username WordPressBackup is_running site=example.com



{
	"data": {
		"backup_id": null,
		"is_running": 0
	},
	"warnings": null,
	"metadata": {},
	"errors": null,
	"status": 1,
	"messages": null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
sitestring

Required

The WordPress site's URL.

A URL without the protocol prefix.


example.com


example.com/wordpress


Returns

ReturnTypeDescriptionPossible valuesExample
backup_idstringThe unique ID of the backup process.A valid string.

example.com__2018-10-10T10:53:31-0500

is_running

BooleanWhether a backup is active.
  • 1 — Backup in progress.
  • 0 — No backup in progress.
0