Child pages
  • UAPI Functions - WordPressRestore::cleanup
Skip to end of metadata
Go to start of metadata

Description

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.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/WordPressRestore/cleanup?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.
 
// Clean up after a WordPress site backup restoration.
 $instances = $cpanel->uapi(
    'WordPressRestore', 'cleanup',
	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.
 
# Clean up after a WordPress site backup restoration.
my $instances = $cpliveapi->uapi(
    'WordPressRestore', 'cleanup',
	{
		'site' => 'example.com'
	}
);


Note:

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

 cPanel Template Toolkit
<!-- Clean up after a WordPress site backup restoration. -->
[% data = execute( 'WordPressRestore', 'cleanup', { 'site' => 'example.com' } ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username WordPressRestore cleanup 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)
{
	"data": 1,
	"errors": null,
	"warnings": null,
	"metadata": {},
	"messages": null,
	"status": 1
}


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

data

BooleanWhether the system cleaned up the temporary system resources.
  • 1 — Successful.
  • 0 — Unsuccessful.
1