Cancel pending DNSSEC transition | regfish DNS & TLS API

POST

/dns/{domain}/dnssec/cancel

DomainDNSSECCancelByDomain

Authentication

x-api-key

Getting startedAuthentication Regfish ConsoleCreate an API key in the regfish console and test it

Parameters

Name

Type

Format

Required

Description

domain

path

string

—

Required

Fully Qualified Domain Name.

Request example

POST

curl --request POST \
  --url 'https://api.regfish.com/dns/www.example.com/dnssec/cancel' \
  --header 'x-api-key: YOUR_API_KEY'

Responses

200

DNSSEC transition cancelled or current stable state returned

application/jsondnssecResponse

Response example 200

{
  "success": true,
  "code": 0,
  "response": {
    "configured": true,
    "dnssec_state": "active",
    "mode": "none",
    "desired_state": "disabled",
    "live_state": "disabled",
    "capabilities": {
      "supported": true,
      "provider": "example",
      "mode_regfish_available": true,
      "mode_external_available": true,
      "accepted_record_kinds": [
        "ds"
      ],
      "min_records": 1,
      "accepted_algorithms": [
        1
      ]
    },
    "desired_records": [
      {
        "kind": "ds",
        "algorithm": 1
      }
    ],
    "live_records": [
      {
        "kind": "ds",
        "algorithm": 1
      }
    ],
    "using_regfish_nameservers": true,
    "legacy_mode": true,
    "zone_signed": true,
    "zone_pending_disable": true
  }
}

401

Unauthorized

application/jsonError

Response example 401

{
  "success": false,
  "message": "Unauthorized",
  "error": "Unauthorized"
}

404

Domain not found

application/jsonError

Response example 404

{
  "success": false,
  "message": "Domain not found",
  "error": "Domain not found"
}

409

No cancellable DNSSEC transition exists for this domain or the current transition cannot be rolled back automatically

application/jsonError

Response example 409

{
  "success": false,
  "message": "No cancellable DNSSEC transition exists for this domain or the current transition cannot be rolled back automatically",
  "error": "No cancellable DNSSEC transition exists for this domain or the current transition cannot be rolled back automatically"
}