< All Topics

domain/listsubdomains

Description

Lists all existing subdomains of 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.

Example

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

$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'domain/listsubdomains',
];

$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

{
    "result": "success",
    "data": [
        {
            "subdomain": "sub.spanel.io",
            "path": "/home/spanelio/sub.spanel.io",
            "modsecurity": "1",
            "localpath": "sub.spanel.io"
        },
        {
            "subdomain": "sub2.spanel.io",
            "path": "/home/spanelio/sub2.spanel.io",
            "modsecurity": "1",
            "localpath": "sub2.spanel.io"
        }
    ]
}
Previous domain/removedomain
Next domain/addsubdomain
Table of Contents