< All Topics

domain/changesubdomainpath

Description

Changes an existing subdomain’s folder path. 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.
subdomainstringYesThe full subdomain name (including domain and tld).
pathstringYesThe new domain’s folder path.

Example

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

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

$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": {
        "msg": "The path for subdomain sub.spanel.io has been updated successfully"
    }
}
Previous domain/addsubdomain
Next domain/removesubdomain
Table of Contents