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 Networks API

The Networks API from NetBird — 7 operation(s) for networks.

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

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

This API exposes 16 operations across 7 paths, and defines 9 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.

16 operations 7 paths 9 schemas 3 DELETE7 GET3 POST3 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 Networks 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 16

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

Networks 16
GET
/api/networks
List all Networks
→ 200400401403500
POST
/api/networks
Create a Network
body → 200400401403500
GET
/api/networks/{networkId}
Retrieve a Network
1 param → 200400401403500
PUT
/api/networks/{networkId}
Update a Network
1 param body → 200400401403500
DELETE
/api/networks/{networkId}
Delete a Network
1 param → 200400401403500
GET
/api/networks/{networkId}/resources
List all Network Resources
1 param → 200400401403500
POST
/api/networks/{networkId}/resources
Create a Network Resource
1 param body → 200400401403500
GET
/api/networks/{networkId}/resources/{resourceId}
Retrieve a Network Resource
2 params → 200400401403500
PUT
/api/networks/{networkId}/resources/{resourceId}
Update a Network Resource
2 params body → 200400401403500
DELETE
/api/networks/{networkId}/resources/{resourceId}
Delete a Network Resource
2 params → 200400401403500
GET
/api/networks/{networkId}/routers
List all Network Routers
1 param → 200400401403500
POST
/api/networks/{networkId}/routers
Create a Network Router
1 param body → 200400401403500
GET
/api/networks/{networkId}/routers/{routerId}
Retrieve a Network Router
2 params → 200400401403500
PUT
/api/networks/{networkId}/routers/{routerId}
Update a Network Router
2 params body → 200400401403500
DELETE
/api/networks/{networkId}/routers/{routerId}
Delete a Network Router
2 params → 200400401403500
GET
/api/networks/routers
List all Network Routers
→ 200400401403500

Schemas 9

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

Network
NetworkResourceType
string
Network resource type based of the address
NetworkResourceRequest
NetworkResource
NetworkRouterRequest
object
5 properties 3 required
GroupMinimum
object
5 properties 4 required
NetworkRouter
NetworkRequest
object
2 properties 1 required
NetworkResourceMinimum
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-networks-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 DNS Zones 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