Skip to main content
POST
/
dnszone
/
records
/
scan
Trigger a background scan for pre-existing DNS records. Can use ZoneId for existing zones or Domain for pre-zone creation scenarios.
curl --request POST \
  --url https://api.bunny.net/dnszone/records/scan \
  --header 'AccessKey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ZoneId": 123,
  "Domain": "<string>"
}
'
{
  "JobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "Status": "Pending"
}

Authorizations

​
AccessKey
string
header
required

API Access Key authorization header

Body

​
ZoneId
integer<int64> | null

The ID of the DNS Zone to scan. Either ZoneId or Domain must be provided, but not both.

​
Domain
string | null

The domain name to scan. Either ZoneId or Domain must be provided, but not both. Can be used even before creating the DNS zone.

Response

DNS record scan job triggered successfully

​
JobId
string<uuid>
required
​
Status
enum<string>

0 = Pending
1 = InProgress
2 = Completed
3 = Failed

Available options:
Pending,
InProgress,
Completed,
Failed
Example:

"Pending"