Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - WordPressBackup::cancel - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - WordPressBackup::cancel
Skip to end of metadata
Go to start of metadata

Description

This function cancels a WordPress® site backup.

Note:

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

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/WordPressBackup/cancel?site=example.com


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Cancel the WordPress site backup.
 $instances = $cpanel->uapi(
    'WordPressBackup', 'cancel',
array( 
        'site' => 'example.com'
    )
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Cancel the WordPress site backup.
my $instances = $cpliveapi->uapi(
    'WordPressBackup', 'cancel',
	{
		'site' => 'example.com'
	}
);


Note:

For more information, read our Guide to the LiveAPI System.

 Command Line
uapi --user=username WordPressBackup cancel site=example.com


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
	"messages": null,
	"errors": null,
	"data": {
		"site": "example.com",
		"ok": 0
	},
	"status": 1,
	"metadata": {},
	"warnings": null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
sitestring

Required

The WordPress site's URL.

A URL without the protocol prefix.

example.com
example.com/wordpress

Returns

ReturnTypeDescriptionPossible valuesExample
okBooleanWhether the system cancelled an active backup.
  • 1 — Backup cancelled.
  • 0 — Could not cancel backup or no active backup in progress.
0
sitestringThe site's URL.A URL without the protocol prefix.
example.com