NetBird Full API Reference + Read-Only MCP Prototype
GET/api/dns/zones/{zoneId}

Get a DNS zone

Retrieves a specific DNS zone. Use zoneId to identify the zone whose configuration and records you need to inspect.

1 parameter
zoneIdstringrequired
The unique identifier of the DNS zone to retrieve.

6 status codes
200Returns a DNS zone object containing its identifier, name, domain, enabled status, search-domain setting, distribution groups, and records.
idstringrequired
Zone ID
recordsarray<object>required
DNS records associated with this zone
distribution_groupsarray<string>required
Group IDs that defines groups of peers that will resolve this zone
domainstringrequired
Zone domain (FQDN)
enable_search_domainbooleanrequired
Enable this zone as a search domain
enabledbooleanrequired
Zone status
Default:true
namestringrequired
Zone name identifier
400Returned when the request is invalid.
401Returned when authentication is required but missing or invalid.
403Returned when access to the DNS zone is forbidden.
404Returned when the DNS zone cannot be found.
500Returned when an internal server error occurs.

Error handling

A 400 indicates a bad request; a 401 means authentication is required; a 403 indicates access is forbidden. A 404 is returned when the zoneId path parameter does not identify an available zone, and a 500 indicates an internal server error.