Page tree
Skip to end of metadata
Go to start of metadata

Description

This function updates a WordPress® cPAddon instance's administrator password.

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/WordPressInstanceManager/change_admin_password?id=cPanel__Blogs__WordPressX.0.1491917088&password=luggage12345

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.
 
// Update the WordPress instance's administrator password.
 $instances = $cpanel->uapi(
    'WordPressInstanceManager', 'change_admin_password',
	    array(
        'id'         =>   'cPanel__Blogs__WordPressX.0.1491917088',
		'password'	 =>	  'luggage12345'
        )
);

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.
 
# Update the WordPress instance's administrator password.
my $instances = $cpliveapi->uapi(
    'WordPressInstanceManager', 'change_admin_password',
	    {
        'id'         =>   'cPanel__Blogs__WordPressX.0.1491917088',
		'password'	 =>	  'luggage12345'
        }
);

Note:

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

 cPanel Template Toolkit
<!-- Update the WordPress instance's administrator password. -->
[% data = execute( 'WordPressInstanceManager', 'change_admin_password'{ 'id' => 'cPanel__Blogs__WordPressX.0.1491917088', 'password' => 'luggage12345', } ); %]

Note:

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

 Command Line
uapi --user=username WordPressInstanceManager change_admin_password id=cPanel__Blogs__WordPressX.0.1491917088 password=luggage12345

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
	"errors": null,
	"status": 1,
	"metadata": {},
	"messages": null,
	"data": null
}

Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
idstring

Required

The cPAddon instance's unique ID.

Note:

You can retrieve an instance ID with the get_instances function.

A valid instance ID.

cPanel__Blogs__WordPressX.0.1491917088

passwordstring

Required

The cPAddon instance's new administrator password.

A valid string.luggage12345

 

Returns

This function only returns metadata.