NetBird Instance API
Instance setup and status endpoints for initial configuration.
NetBird Instance API is one of 39 APIs that NetBird publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Instance. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 3 paths, and defines 4 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
NetBird Instance 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 3
Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Instance setup and status endpoints for initial configuration.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SetupRequest (5 properties), InstanceVersionInfo (4 properties), SetupResponse (3 properties), InstanceStatus (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NetBird 12
Other APIs NetBird publishes across the network.