Self Help Documentation
< All Topics

domain/removesubdomain

PostedFebruary 23, 2022
UpdatedApril 26, 2023

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

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

Example

PHP
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
$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 );

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 subdomains have been deleted successfully"
    }
}
Table of Contents