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

MSP portal for Tenant management.

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

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

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

8 operations 6 paths 6 schemas 1 GET5 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 MSP 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 8

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

MSP 8

MSP portal for Tenant management.

GET
/api/integrations/msp/tenants
Get MSP tenants
→ 200400403500
POST
/api/integrations/msp/tenants
Create MSP tenant
body → 200400403500
PUT
/api/integrations/msp/tenants/{id}
Update MSP tenant
1 param body → 200400403500
POST
/api/integrations/msp/tenants/{id}/unlink
Unlink a tenant
1 param body → 200400403404500
POST
/api/integrations/msp/tenants/{id}/dns
Verify a tenant domain DNS challenge
1 param → 200400403404500501
POST
/api/integrations/msp/tenants/{id}/subscription
Create subscription for Tenant
1 param body → 200400403404500
POST
/api/integrations/msp/tenants/{id}/invite
Invite existing account as a Tenant to the MSP account
1 param → 200400403404500
PUT
/api/integrations/msp/tenants/{id}/invite
Response by the invited Tenant account owner
1 param body → 200400403404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TenantResponse (10 properties), CreateTenantRequest (3 properties), TenantGroupResponse (2 properties), UpdateTenantRequest (2 properties). Each schema is shown below with its type and property counts.

DNSChallengeResponse
object
1 property 1 required
UpdateTenantRequest
object
2 properties 2 required
GetTenantsResponse
array
TenantGroupResponse
object
2 properties 2 required
TenantResponse
object
10 properties 8 required
CreateTenantRequest
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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