DNS API-Referenz
v1.6.2
Get DNS zone details
Retrieve the complete DNS zone for the specified domain. The response includes SOA metadata, delegated nameservers, DNSSEC status, record counts, and all records stored in the zone, including
NS records.GET
/dns/zones/{domain}
DNSZonesByDomain
Authentifizierung
Parameter
Name
Typ
Format
Pflicht
Description
domain
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
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
Response-Beispiel 401
{
"success": false,
"message": "Unauthorized",
"error": "Unauthorized"
}404
DNS zone not found
Response-Beispiel 404
{
"success": false,
"message": "DNS zone not found",
"error": "DNS zone not found"
}500
Unexpected error
Response-Beispiel 500
{
"success": false,
"message": "Unexpected error",
"error": "Unexpected error"
}Verwandte Modelle
baseResult
baseResult
dnsZoneCounts
dnsZoneCounts
dnsZoneDelegationNameserver
dnsZoneDelegationNameserver
dnsZoneDetailResponse
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
dnsZoneSOA
dnsZoneSummaryResponse
dnsZoneSummaryResponse
dnssecCapabilities
dnssecCapabilities
dnssecDisplayState
High-level DNSSEC status.
dnssecJobResponse
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
dnssecRecord
dnssecRecord
dnssecRecordKind
dnssecRecordKind
dnssecResponse
dnssecResponse
dnssecState
Fine-grained registry DNSSEC state.
Error
Error
fqdn
Fully Qualified Domain Name (FQDN, ending with a period).
fqdn_relaxed
Fully Qualified Domain Name.
ipv4
ipv4
rrid
Resource Record ID
Community
Werden Sie 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. Werden Sie Teil der Community und profitieren Sie von den Vorteilen der DNS-Automatisierung. Das DNS API steht jedem regfish-Kunden kostenlos zur Verfügung.