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

Check out our new API beta site!

Child pages
  • WHM API 1 Functions - export_zone_key
Skip to end of metadata
Go to start of metadata

Description

This function exports a DNSSEC security key to a domain.

Note:

Only servers that run PowerDNS can use DNSSEC. If you call this function on a server that doesn't use PowerDNS, you will receive an error.


Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/export_zone_key?api.version=1&domain=example.com&key_id=1
 Command Line
whmapi1 export_zone_key domain=example.com key_id=1


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "data":{
      "key_type":"CSK",
      "key_tag":40481
   },
   "metadata":{
      "command":"export_zone_key",
      "version":1,
      "reason":"OK",
      "result":1
   }
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain to export the security key to.

A valid domain.example.com
key_idinteger

Required

The security key's ID.

Note:

You can locate the ID with the WHM AP1 fetch_ds_records_for_domains function.

A valid integer.1

Returns

ReturnTypeDescriptionPossible valuesExample
key_tagstringThe security key's integer value.A valid integer.40481
key_typestringThe type of security key.
  • CSK — Combined Signing Key.
  • KSK — Key Signing Key.
  • ZSK — Zone Signing Key.
CSK