You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • WHM API 1 Functions - disable_dnssec_for_domains
Skip to end of metadata
Go to start of metadata

Description

This function disables DNSSEC on the domain.

Note:

Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.


Warning:

  • This action is irreversible. If you disable DNSSEC on the domain, you will lose the associated keys. You can only retrieve the keys by restoring them from a full back up of the account.
  • If you disable DNSSEC, you must remove the Delegation of Signing (DS) records on your DNS server and with your registrar.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/disable_dnssec_for_domains?api.version=1&domain=example.com
 Command Line
whmapi1 disable_dnssec_for_domains domain=example.com


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "data":{
      "domains":[
         {
            "disabled":1,
            "domain":"example.com"
         }
      ]
   },
   "metadata":{
      "result":1,
      "version":1,
      "reason":"OK",
      "command":"disable_dnssec_for_domains"
   }
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain for which to disable DNSSEC.

Note:

To disable DNSSEC for multiple domains, duplicate or increment the parameter name. For example, to check three domains, you could:

  • Use the domain parameter multiple times.
  • Use the domain, domain-1, domain-2 parameters.
A valid domain.example.com

Returns

ReturnTypeDescriptionPossible valuesExample
domainsarray of hashesAn array of hashes that contains information about each domain.Each hash contains the disabled, and domain, and error returns.

disabled

Boolean

Whether the system disabled DNSSEC.

The function returns this value in the domains hash.

  • 1 — Disabled.
  • 0 — The system failed to disable DNSSEC.
1

domain

string

The domain for which the system disabled DNSSEC.

The function returns this value in the domains hash.

A valid domain.example.com