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

Check out our new API beta site!

Child pages
  • UAPI Functions - DNSSEC::unset_nsec3
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.

Important:

In cPanel & WHM version 76 and later, when you disable the DNS role, the system disables this function.

Examples 


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


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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

// Unset NSEC3.
$sa_settings = $cpanel->uapi(
    'DNSSEC', 'unset_nsec3',
    array(
        'domain'     => 'example.com',
    )
);


Note:

For more information, read our Guide to the LiveAPI System.

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

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


Note:

For more information, read our Guide to the LiveAPI System.


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


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
   "apiversion":3,
   "module":"DNSSEC",
   "func":"unset_nsec3",
   "result":{
      "status":1,
      "messages":null,
      "errors":null,
      "metadata":{
      },
      "data":{
         "disabled":{
            "example.com":1
         }
      },
      "warnings":null
   }
}


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

A valid domain.example.com

Returns

Notes:

  • We added the disabled and DOMAIN returns in cPanel & WHM version 86.
  • We removed the disabled and DOMAIN returns from the metadata in cPanel & WHM version 88.
ReturnTypeDescriptionPossible valuesExample
disabledarray of hashes

An array of hashes that contain the domains for which the system disabled NSEC3.

Each hash contains the DOMAIN return.


DOMAIN

Boolean

Whether the system disabled NSEC3 on the domain.

Note:

This return's name is the domain parameter's value.

The function returns this value in the disabled hash.

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