domain/addsubdomain

Description

Adds a new subdomain to an existing domain in a specified SPanel user account. The provided folder (path parameter) will be automatically created if it does not exist.

Parameters

Field	Type	Required	Description
token	string	Yes	Authorizing API token – check API Basics for more information.
accountuser	string	Yes	The SPanel user account that is being managed or viewed.
action	string	Yes	The category and function being executed.
domain	string	Yes	The existing domain’s name to add a subdomain to.
subdomain	string	Yes	The new subdomain name (only the subdomain and not the full name with domain and tld – see the example).
path	string	Yes	The new subdomain’s folder path.

Example

$endpointUrl = 'https://123.123.123.123/spanel/api.php';

$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'domain/addsubdomain',
  'domain' => 'spanel.io',
  'subdomain' => 'sub',
  'path' => 'sub.spanel.io'
];

$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 );Code language: PHP (php)

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

Output

{
    "result": "success",
    "data": {
        "msg": "The subdomain sub.spanel.io has been created successfully"
    }
}Code language: JSON / JSON with Comments (json)