domain/removesubdomain

Description

Removes an existing subdomain from the selected SPanel user account. The domain’s folder and files remain intact and must be deleted manually.

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.
subdomain	string|array	Yes	The subdomain name to remove. An array with multiple subdomain names is supported as well.

Example

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

$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'domain/removesubdomain',
  'subdomain' => 'subdomain.spanel.io',
//'subdomain' => ['subdomain.spanel.io', 'subdomain2.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 subdomains have been deleted successfully"
    }
}Code language: JSON / JSON with Comments (json)