Self Help Documentation
< All Topics

domain/createredirect

PostedFebruary 23, 2022
UpdatedApril 26, 2023

Description

Creates a new redirect for an existing domain in 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.
domainstringYesThe domain for which the redirect is being created.
typeintNoDefault: 301. The redirect type, possible values: 301 – permanent redirect; 302 – temporary redirect.
sourcestringNoDefault: empty (unset). The source URL path that needs to be redirected, without protocol or domain. Don’t send this parameter or leave empty if the redirect needs to be done for the whole domain.
destinationstringYesThe full destination URL with protocol, domain, tld and path.
wildcardboolNoDefault: false. True will redirect all files within a directory to the same file name in the destination URL.

Example

PHP
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'domain/createredirect',
  'domain' => 'testdomain.com',
  //'type' => 301,
  //'source' => 'oldfile.html',
  'destination' => 'https://spanel.io/testdomainredirect',
  //'wildcard' => true
];
 
$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": "Redirect of type Permanent (301) from testdomain.com/ to https://spanel.io/testdomainredirect is successfully created."
    }
}
Table of Contents