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

Check out our new API beta site!

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

Description

This function exports a domain's DNSKEY record value.

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

// Export DNSSEC public key.
$export_key = $cpanel->uapi(
    'DNSSEC', 'export_zone_dnskey',
    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.

# Export DNSSEC public key.
my $export_key = $cpliveapi->uapi(
    'DNSSEC', 'export_zone_dnskey',
    {
        'domain' => 'example.com',
        'key_id' => '12345',
    }
);


Note:

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

 Command Line
uapi --user=username DNSSEC export_zone_dnskey 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)
{
	"errors": null,
	"metadata": {},
	"messages": null,
	"data": {
		"key_id": "3",
		"dnskey": "AwEAAeFOvNR7BoSQ3j/V0vGk0KY/RGWJASKVrXpQSJQ4ERsKL6C/b2nJA13TI46EG4Lw6m2Qffk7NrzgRU5gACaTe2nmvMhoFRfUCljv0tpKkWnBwD6UMTdiCWR+rxNH6BT7AKGd50BzAguwHIBPEGhisdebZDypCiK6RRSXpC/UHkOjJpAQWx15jdkhgXXOlkiEyZdmi38nN2tJErhOWQPVZTzfSLpbd11I9eIyxJty1Y8/LLjwZQQ4S7JaYmlz5AOBd56yt7mQulnZOpVypUSSHj9rtQVTnNJDZP1JPqwbrYvuBeUj7YWFpn6KODNDwYTvDazu7noAXnzi043+Ekojvy8=",
		"success": 1
	},
	"status": 1
}


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 from which to fetch the DNSKEY record value.

A valid domain that the cPanel account owns.example.com
key_idinteger

Required.

The DNSSEC record's ID.

A positive integer.12345

Returns

Return

TypeDescriptionPossible valuesExample

dnskey

string


The DNSKEY record value.

A valid DNSKEY record.

 Click to view...
AwEAAch8SGW4vE6PjFWA9rbUm0AfTq+gJ0HC/nLu+2axdWHBIStt9lsOzKDorAr4vlmhlJzEzA62s96xp6mZ7XHUyWnkFwLs8obo6upL2in4h1ToOxzVl3lTs8O+kWtDq5/h1nwFlPDs9zpLJhlkTCtx2OTGbvimEYeqwPolUuSQR/Yb

key_id

integerThe DNSSEC record's ID.A positive integer.12345
successBooleanWhether the DNSKEY record exported successfully.
  • 1 — The system exported the record successfully.
  • 0 — The system failed to export the record.
1