NetBird Full API Reference + Read-Only MCP Prototype
POST/api/dns/zones

Create a DNS zone

Creates a custom DNS zone with its domain, distribution groups, and search-domain setting. Supply name, domain, enable_search_domain, and distribution_groups; enabled defaults to true when omitted. A 200 response returns the created DNS zone.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields

DNS zone configuration. Include name, domain, enable_search_domain, and distribution_groups; enabled is optional.

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
enabledbooleanoptional
Zone status
Default:true
namestringrequired
Zone name identifier

5 status codes
200Returns the created DNS zone object, including its identifier, settings, 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, a required field is missing, or a value fails validation.
401Returned when authentication is required but missing or invalid.
403Returned when the request is forbidden.
500Returned when an internal server error occurs.

Error handling

A 400 is returned when the request is invalid. A 401 is returned when authentication is missing or invalid. A 403 indicates insufficient permission, and a 500 indicates an internal server error. Include name, domain, enable_search_domain, and distribution_groups; name must be 1–255 characters.