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. 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/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.

 

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


Note:

For more information, read our Guide to Template Toolkit documentation. 

 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)
{  
   "metadata":{  
      "DNSSEC":{  
         "disabled":{  
            "example.com":1
         }
      }
   },
   "status":1,
   "data":null,
   "messages":null,
   "errors":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

This function returns only metadata.