NetBird

Configuration

To use this provider, add an entry to creds.json with TYPE set to NETBIRD along with a NetBird API token.

Example:

creds.json

{
  "netbird": {
    "TYPE": "NETBIRD",
    "token": "your-netbird-api-token"
  }
}

If you use a self-hosted instance you need to set apiurl in the credentials configuration.

Example:

creds.json

{
  "netbird": {
    "TYPE": "NETBIRD",
    "token": "your-netbird-api-token",
    "apiurl": "https://your-netbird-host/api"
  }
}

Metadata

This provider recognizes the following metadata fields:

Key	Type	Value	Description
netbird_enabled	string	"true"/"false"	Whether the zone is enabled.
netbird_enable_search_domain	string	"true"/"false"	Whether to enable this zone as a search domain.

NOTE: If metadata fields are not set, DNSControl will leave them unchanged in NetBird.

Usage

An example configuration:

dnsconfig.js

D("example.com", REG_NONE, DnsProvider(DSP_NETBIRD),
    { no_ns: "true" }, // NetBird does not expose nameservers
    A("test", "1.2.3.4"),
    AAAA("ipv6test", "2001:db8::1"),
    CNAME("www", "example.com."),
);

NOTE: NetBird does not expose nameservers, so {no_ns: "true"} should be set on all domains to suppress the "Skipping registrar" warning.

To configure zone options, use metadata:

dnsconfig.js

D("example.com", REG_NONE,
    {
        no_ns: "true",
        netbird_enabled: "true",
        netbird_enable_search_domain: "true",
    },
    DnsProvider(DSP_NETBIRD),
    A("test", "1.2.3.4"),
);

Activation

NetBird depends on a NetBird API token. You can generate a personal access token in the NetBird dashboard.

Caveats

NetBird API currently supports the following DNS record types:

• A

• AAAA

• CNAME

For more information, see the NetBird API documentation.

Feature Summary

• Provider Type

  • Official Support: ❌

  • DNS Provider: ✅

  • Registrar: ❌

• Provider API

  • Concurrency Verified: ✅

  • dual host: ❌

  • create-domains: ✅

  • get-zones: ✅

• DNS extensions

  • ALIAS: ❌

  • CSYNC: ❌

  • DNAME: ❌

  • LOC: ❌

  • PTR: ❌

  • RP: ❌

  • SOA: ❌

• Service discovery

  • DHCID: ❌

  • NAPTR: ❌

  • SRV: ❌

  • SVCB: ❌

• Security

  • CAA: ❌

  • HTTPS: ❌

  • OPENPGPKEY: ❌

  • SMIMEA: ❌

  • SSHFP: ❌

  • TLSA: ❌

• DNSSEC

  • AUTODNSSEC: ❌

  • DNSKEY: ❌

  • DS: ❌