Self Help Documentation
< All Topics

software/installwp

Posted
Updated

Description

Installs WordPress for an existing domain from a given SPanel user account.

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.
domainstringYesThe domain to install WordPress on. Must already exist in the account.
folderstringNoInstallation folder under the selected domain’s document root (for example: blog). Use empty value to install in the main folder.
usernamestringYesWordPress administrator username.
passwordstringYesWordPress administrator password.
emailstringYesWordPress administrator email address.
sitetypestringNoSite template type. Supported values: custom, store, business, blog. Defaults to custom if nothing is provided.
pluginsarrayNoOptional list of plugin slugs (only used when sitetype is custom). Supported values: woocommerce, jetpack, all-in-one-seo-pack, wpforms-lite, google-analytics-for-wordpress, optinmonster.

Example

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'software/installwp',
  'domain' => 'example.com',
  'folder' => 'blog',
  'username' => 'wpadmin',
  'password' => 'StrongPassword_123!',
  'email' => '[email protected]',
  'sitetype' => 'store',
  /* 'plugins' => ['woocommerce', 'jetpack'] */
];
 
$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
{
    "result": "success",
    "data": {
        "msg": "The WordPress installation was completed successfully.",
        "fullDomainUrl": "example.com/blog"
    }
}
Table of Contents