Get DNS zone details | regfish DNS & TLS API

GET

/dns/zones/{domain}

DNSZonesByDomain

Authentifizierung

x-api-key

SchnellstartAuthentifizierung Regfish ConsoleAPI-Key im Regfish-Interface anlegen und testen

Parameter

Name

Typ

Format

Pflicht

Description

domain

path

string

—

Pflicht

Fully Qualified Domain Name.

Request-Beispiel

GET

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

Responses

200

Detailed DNS zone

application/jsondnsZoneDetailResponse

Response-Beispiel 200

{
  "success": true,
  "code": 0,
  "response": {
    "domain": "www.example.com",
    "origin": "www.example.com.",
    "active": true,
    "signed": true,
    "using_regfish_nameservers": true,
    "delegation_nameservers": [
      {
        "host": "www.example.com."
      }
    ],
    "soa": {
      "primary_nameserver": "www.example.com.",
      "mailbox": "www.example.com.",
      "serial": 1,
      "refresh": 1,
      "retry": 1,
      "expire": 1,
      "minimum": 1,
      "ttl": 1
    },
    "record_count": 1,
    "dnssec_state": "active",
    "dnssec": {
      "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": [
          null
        ],
        "min_records": 1,
        "accepted_algorithms": [
          null
        ]
      },
      "desired_records": [
        {}
      ],
      "live_records": [
        {}
      ],
      "using_regfish_nameservers": true,
      "legacy_mode": true,
      "zone_signed": true,
      "zone_pending_disable": true
    },
    "counts": {
      "records_total": 1,
      "records_active": 1,
      "records_auto": 1,
      "records_manual": 1,
      "by_type": {}
    },
    "records": [
      {
        "id": 1,
        "name": "example",
        "type": "example",
        "ttl": 1,
        "auto": true,
        "active": true,
        "ts_created": 1,
        "ts_updated": 1
      }
    ]
  }
}

401

Unauthorized

application/jsonError

Response-Beispiel 401

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

404

DNS zone not found

application/jsonError

Response-Beispiel 404

{
  "success": false,
  "message": "DNS zone not found",
  "error": "DNS zone not found"
}

500

Unexpected error

application/jsonError

Response-Beispiel 500

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

Verwandte Modelle

baseResult

dnsZoneCounts

dnsZoneDelegationNameserver

dnsZoneDetailResponse

dnsZoneRecordResponse

Superset record representation returned by the detailed zone endpoint. Record-specific fields such as `priority`, `flags`, or `tag` are included when applicable.

dnsZoneSOA

dnsZoneSummaryResponse

dnssecCapabilities

dnssecDisplayState

High-level DNSSEC status.

dnssecJobResponse

dnssecMode

Requested DNSSEC operating mode. - `none`: no registry DNSSEC should remain active - `regfish`: regfish signs the zone and manages registry trust anchors - `external`: the caller supplies DNSSEC records for external authoritative nameservers

Fine-grained registry DNSSEC state.

Error

fqdn

Fully Qualified Domain Name (FQDN, ending with a period).

fqdn_relaxed

Fully Qualified Domain Name.

ipv4

rrid

Resource Record ID

Werde ein Teil der Community

Das DNS API von Regfish ist die perfekte Lösung für Entwickler, die ihre Domains und DNS-Zonen automatisieren möchten. Werde Teil der Community und profitiere von den Vorteilen der DNS-Automatisierung. Das DNS API steht jedem Regfish-Kunden kostenlos zur Verfügung.