Child pages
  • UAPI Functions - DNSSEC::remove_zone_key

Versions Compared

Key

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

Description

Excerpt
This function removes a DNSSEC security key.


Multiexcerpt include
SpaceWithExcerptLIB
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/remove_zone_key?domain=example.com&key_id=12345

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


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

// Remove a DNSSEC security key.
$sa_settings = $cpanel->uapi(
    'DNSSEC', 'remove_zone_key',
    array(
        'domain'     => 'example.com',
        'key_id'     => '12345',
    )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Remove a DNSSEC security key.
my $vinz_clortho = $cpliveapi->uapi(
    'DNSSEC', 'remove_zone_key',
    {
        'domain'     => 'example.com',
        'key_id'     => '12345',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink



Expand
titleCommand Line


Code Block
uapi --user=username DNSSEC remove_zone_key domain=example.com key_id=12345

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


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


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required.

The security key's domain.

A valid domain.example.com
key_idinteger

Required.

The security key's ID. 

A valid integer.12345

Returns

This function returns only metadata.