Disable DNSSEC security key

This function deactivates a DNSSEC security key.

Important:

When you disable the DNS role, the system disables this function.

Authorizations:
query Parameters
domain
required
string <domain>

The security key's domain.

Example: domain=example.com
key_id
required
integer >= 1

The security key's ID.

Example: key_id=1

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  DNSSEC \
  deactivate_zone_key \
  domain='example.com' \
  key_id='1'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "deactivate_zone_key",
  • "module": "DNSSEC",
  • "result": {
    • "data": {
      • "domain": "example.com",
      • "error": "Error: Invalid key_id or domain specified: No such key present for domain.",
      • "key_id": "1",
      • "success": 1
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}