We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function imports a DNSSEC security key.

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/import_zone_key?api.version=1&domain=example.com&key_type=ksk&key_data=Private-key-format:%20v1.2%0AAlgorithm:%2013%20\(ECDSAP256SHA256\)%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A
 Command Line
whmapi1 import_zone_key domain=example.com key_type=ksk key_data='Private-key-format:%20v1.2%0AAlgorithm:%2013%20\(ECDSAP256SHA256\)%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A'


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":{
      "import_key_id":"1"
   },
   "metadata":{
      "command":"import_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 for which to import the security key.

A valid domain.example.com
key_typestring

Required

The security key's type.

  • ksk
  • zsk

Note:

You must call these values in lowercase.

ksk
key_datastring

Required

The security key's data.

The key data that the pdnsuti utility's export-zone-key call returns.
 Click to view...
'Private-key-format:%20v1.2%0AAlgorithm:%2013%20\(ECDSAP256SHA256\)%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A'

Returns

ReturnTypeDescriptionPossible valuesExample
import_key_idintegerThe system's assigned ID for the imported security key.A positive integer.1