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

Check out our new API beta site!

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

Description

This function configures the domain to use Next Secure Record (NSEC) semantics instead of Next Secure Record 3 (NSEC3) semantics.

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.


Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/unset_nsec3_for_domains?api.version=1&domain=example.com
 Command Line
whmapi1 unset_nsec3_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":[
         {
            "domain":"example.com",
            "disabled":1
         }
      ]
   },
   "metadata":{
      "version":1,
      "reason":"OK",
      "command":"unset_nsec3_for_domains",
      "result":1
   }
}


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 NSEC3 semantics and use NSEC semantics.

A valid domain.example.com

Returns

ReturnTypeDescriptionPossible valuesExample
domainshashAn array of hashes that contains information about each domain.Each hash contains the domaindisabled, and error returns.

domain

string

The domain for which to disable NSEC3.

The function returns this value in the domains hash.

A valid domain.example.com

disabled

Boolean

Whether the system disabled NSEC3.

The function returns this value in the domains hash.

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

error

string

An error message that describes why the system could not disable NSEC3.

Note:

The function only displays this return when the disabled return is a 0 value.

The function returns this value in the domains hash.

An error message.Error message.