Child pages
  • UAPI Functions - DNSSEC::unset_nsec3

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt
This function disables Next Secure Record (NSEC) semantics on a domain.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledDNSRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/DNSSEC/unset_nsec3?domain=example.com

Include Page
SPID:_CallUAPIFromBrowserLink
SPID:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

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

Include Page
SPID:_LiveAPIPHPLink
SPID:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
    }
);

Include Page
SPID:_LiveAPIPerlLink
SPID:_LiveAPIPerlLink

 


Expand
titlecPanel Template Toolkit


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

Include Page
SPID:_TTLink
SPID:_TTLink


Expand
titleCommand Line


Code Block
uapi --user=username DNSSEC unset_nsec3 domain=example.com

Include Page
SPID:_UAPICLINote
SPID:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "metadata":{  
      "DNSSEC":{  
         "disabled":{  
            "example.com":1
         }
      }
   },
   "status":1,
   "data":null,
   "messages":null,
   "errors":null
}


Include Page
SPID:_cPanelAPIShellNote
SPID:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required.

The domain on which to disable NSEC3. This action sets the domain to use NSEC semantics.

A valid domain.example.com

Returns

This function returns only metadata.