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 - deactivate_zone_key
Skip to end of metadata
Go to start of metadata

Description

This function deactivates a domain's 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/deactivate_zone_key?api.version=1&domain=example.com&key_id=1
 Command Line
whmapi1 deactivate_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)
{
	"metadata": {
		"result": 1,
		"command": "deactivate_zone_key",
		"version": 1,
		"reason": "OK"
	}
}


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 deactivate a security key.

A valid domain.example.com
key_idinteger

Required

The security key's ID.

Note:

Use the WHM AP1 fetch_ds_records_for_domains function to locate the domain's security key ID.

A valid integer.1

Returns

This function only returns metadata.