Add DNSSEC security key

This function imports 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_data
required
string

The security key data that the pdnsutil utility's export-zone-key call returns.

Example: key_data=Private-key-format:%20v1.2%0AAlgorithm:%2013%20\(ECDSAP256SHA256\)%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A
key_type
required
string

The security key's type.

  • ksk
  • zsk
Enum: "ksk" "zsk"
Example: key_type=ksk

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 \
  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'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "import_zone_key",
  • "module": "DNSSEC",
  • "result": {
    • "data": {
      • "domain": "example.com",
      • "new_key_id": "1",
      • "success": 1
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}