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

Interact with and view information about routes.

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

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

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

5 operations 2 paths 2 schemas 1 DELETE2 GET1 POST1 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 Routes 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 5

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

Routes 5

Interact with and view information about routes.

GET
/api/routes
List all Routes
→ 200400401403500
POST
/api/routes
Create a Route
body → 200400401403500
GET
/api/routes/{routeId}
Retrieve a Route
1 param → 200400401403500
PUT
/api/routes/{routeId}
Update a Route
1 param body → 200400401403500
DELETE
/api/routes/{routeId}
Delete a Route
1 param → 200400401403500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is RouteRequest (13 properties). Each schema is shown below with its type and property counts.

RouteRequest
object
13 properties 8 required
Route

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-routes-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