Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NetBird DNS Zones API

Interact with and view information about custom DNS zones.

NetBird DNS Zones API is one of 39 APIs that NetBird publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DNS Zones. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://api.netbird.io.

10 operations 4 paths 5 schemas 2 DELETE4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.netbird.io
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

NetBird DNS Zones API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as Authorization (TokenAuth). By default, every request must be authenticated.

  • TokenAuth — Enter the token with the Token prefix, e.g. "Token nbpF3f0d.....".

Paths & Operations 10

Across 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

DNS Zones 10

Interact with and view information about custom DNS zones.

GET
/api/dns/zones
List all DNS Zones
→ 200401403500
POST
/api/dns/zones
Create a DNS Zone
body → 200400401403500
GET
/api/dns/zones/{zoneId}
Retrieve a DNS Zone
1 param → 200400401403404500
PUT
/api/dns/zones/{zoneId}
Update a DNS Zone
1 param body → 200400401403404500
DELETE
/api/dns/zones/{zoneId}
Delete a DNS Zone
1 param → 200400401403404500
GET
/api/dns/zones/{zoneId}/records
List all DNS Records
1 param → 200401403404500
POST
/api/dns/zones/{zoneId}/records
Create a DNS Record
1 param body → 200400401403404500
GET
/api/dns/zones/{zoneId}/records/{recordId}
Retrieve a DNS Record
2 params → 200400401403404500
PUT
/api/dns/zones/{zoneId}/records/{recordId}
Update a DNS Record
2 params body → 200400401403404500
DELETE
/api/dns/zones/{zoneId}/records/{recordId}
Delete a DNS Record
2 params → 200400401403404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ZoneRequest (5 properties), DNSRecordRequest (4 properties). Each schema is shown below with its type and property counts.

Zone
DNSRecordType
string
DNS record type
DNSRecordRequest
object
4 properties 4 required
DNSRecord
ZoneRequest
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-dns-zones-api-openapi.yml Raw ↑

Other APIs NetBird publishes across the network.

NetBird Accounts API
NetBird AWS Marketplace API
NetBird Checkout API
NetBird DNS API
NetBird EDR Falcon Integrations API
NetBird EDR FleetDM Integrations API
NetBird EDR Huntress Integrations API
NetBird EDR Intune Integrations API
NetBird EDR Peers API
NetBird EDR SentinelOne Integrations API
NetBird Event Streaming Integrations API
NetBird Events API