Child pages
  • UAPI Functions - DNSSEC::disable_dnssec
Skip to end of metadata
Go to start of metadata

Description

This function disables DNSSEC on the domain.

Warnings:

  • This action is irreversible. If you disable DNSSEC on the domain, you will lose the associated keys. You can only retrieve the previous state with a full backup.
  • If you disable DNSSEC, you must remove the DS records at the registrar.

Important:

In cPanel & WHM version 76 and later, when you disable the DNS role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/disable_dnssec?domain=example.com

Unable to render {include} The included page could not be found.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Disable DNSSEC.
$sa_settings = $cpanel->uapi(
    'DNSSEC', 'disable_dnssec',
    array(
        'domain'     => 'example.com',
    )
);

Unable to render {include} The included page could not be found.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Disable DNSSEC.
my $sa_settings = $cpliveapi->uapi(
    'DNSSEC', 'disable_dnssec',
    {
        'domain'     => 'example.com',
    }
);

Unable to render {include} The included page could not be found.

 cPanel Template Toolkit
<!-- Disable DNSSEC. -->
[% SET sa_settings = execute('DNSSEC', 'disable_dnssec' {'domain' => 'example.com',} ); %]

Unable to render {include} The included page could not be found.

 Command Line
uapi --user=username DNSSEC disable_dnssec domain=example.com

Unable to render {include} The included page could not be found.

 Output (JSON)
{  
   "errors":null,
   "messages":null,
   "status":1,
   "data":null,
   "metadata":{  
      "DNSSEC":{  
         "disabled":{  
            "example.com":1
         }
      }
   }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain on which to disable DNSSEC.

Note:

To enable DNSSEC on multiple domains , increment the parameter name. For example: domain-0 , domain-1,  domain-2 .

A valid domain.example.com

Returns

This function returns only metadata.