Child pages
  • UAPI Functions - DNSSEC::deactivate_zone_key
Skip to end of metadata
Go to start of metadata

Description

This function deactivates a DNSSEC security key.

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/deactivate_zone_key?domain=example.com&key_id=12345


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.

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


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.

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


Note:

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

 Command Line
uapi --user=username DNSSEC deactivate_zone_key domain=example.com key_id=12345


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)
{  
   "status":1,
   "errors":null,
   "messages":null,
   "metadata":{  
		"DNSSEC" : {
			"key_id" : "15",
			"domain" : "roo.tld",
			"success" : 1
     	  } 
  	 },
   "data":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 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.