Newcertbro for Linux

Open-source CLI for TLS automation, DNS DCV, and unattended renewals.

Explore certbro
regfish
DNS automation
v1.6.2
Download OpenAPI
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

Authentication

x-api-key

Parameters

Name
Type
Format
Required
Description
domain
path
string
Required
Fully Qualified Domain Name.

Request example

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 example 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 example 401
{
  "success": false,
  "message": "Unauthorized",
  "error": "Unauthorized"
}
404
DNS zone not found
application/jsonError
Response example 404
{
  "success": false,
  "message": "DNS zone not found",
  "error": "DNS zone not found"
}
500
Unexpected error
application/jsonError
Response example 500
{
  "success": false,
  "message": "Unexpected error",
  "error": "Unexpected error"
}
Community

Become part of the community

The Regfish DNS API is a great solution for developers who want to automate domains and DNS zones. Become part of the community and benefit from DNS automation. The DNS API is available free of charge to every Regfish customer.

Cart
 
Total
€0.00
All prices include VAT.
We use cookies to provide the best possible experience. Choose your preferences for cookie usage. Privacy policy