Description
This function indicates whether the account's domains resolve exclusively to this server.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/DNS/ensure_domains_reside_only_locally?domain-1=example1.com&domain-2=example2.com&domain-3=example3.com
LiveAPI PHP Class
$cpanel = new CPANEL();
$poll = $cpanel->uapi(
'DNS', 'ensure_domains_reside_only_locally',
array(
'domain-1' => 'example1.com',
'domain-2' => 'example2.com',
'domain-3' => 'example3.com'
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $poll = $cpliveapi->uapi(
'DNS', 'ensure_domains_reside_only_locally',
{
'domain-1' => 'example1.com',
'domain-2' => 'example2.com',
'domain-3' => 'example3.com'
}
);
cPanel Template Toolkit
[% execute('DNS', 'ensure_domains_reside_only_locally', { 'domain-1' => 'example1.com','domain-2'=>'example2.com','domain-3'=>'example3.com' } ) %]
Command Line
uapi --user=username DNS ensure_domains_reside_only_locally domain-1=example1.com domain-2=example2.com domain-3=example3.com
|
Output (JSON)
{
"data":[
null,
null,
'The domain resolves to Mars. Beep beep beep.'
],
"messages":null,
"metadata":{
"transformed":1
},
"status":1,
"errors":null
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
domain
|
string
|
Required
The domain to check.
Note:
To check multiple domains, duplicate or increment the parameter name. For example, to check three domains, use the domain parameter multiple times or use the domain-1, domain-2, and domain-3 parameters.
|
A valid string.
|
example1.com
|
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
data
|
array of strings
|
The results from each domain parameter's DNS query.
Note:
The function returns the results from the domains in the same order that you called them.
|
- null — The domain only resolves locally to the server.
- A valid string that explains to where the domain resolves.
|
The domain resolves to Mars. Beep beep beep.
|
