Self Help Documentation
< All Topics

domain/addsubdomain

PostedFebruary 23, 2022
UpdatedApril 26, 2023

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

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 existing domain’s name to add a subdomain to.
subdomainstringYesThe new subdomain name (only the subdomain and not the full name with domain and tld – see the example).
pathstringYesThe new subdomain’s folder path.

Example

PHP
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' => '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 );

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

Output

JSON
PHP
1
2
3
4
5
6
{
    "result": "success",
    "data": {
        "msg": "The subdomain sub.spanel.io has been created successfully"
    }
}
Table of Contents