Self Help Documentation
< All Topics

software/uninstallwp

Posted
Updated

Description

Uninstalls one or more WordPress installations from a given SPanel user account.

Info
Use software/listwpinstalls to get the installation IDs. The uninstall function expects an array of hash values returned by the list function.

Parameters

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token – check API Basics for more information.
accountuserstringYesThe SPanel user account that is being managed or viewed.
actionstringYesThe category and function being executed.
idstring|arrayYesString of a single WordPress installation id or an array if you want to uninstall more than one. Installation ids (hashes) are returned by software/listwpinstalls.

Example

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'software/uninstallwp',
  'id' => [
    'eW91J3JlIHNvIGN1cmlvdXMgOik='
  ],
];
 
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endpointUrl);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);
$jsonOutput = curl_exec( $ch );

You can find more information about the Endpoint URL in our API Basics article.

Output

PHP
1
2
3
4
5
6
7
8
9
{
    "result": "success",
    "data": {
        "msg": "The selected WordPress installations were uninstalled successfully.",
        "uninstalledIds": [
            "eW91J3JlIHNvIGN1cmlvdXMgOik="
        ]
    }
}
Table of Contents