How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
NetBird

NetBird Services API

Interact with and view information about reverse proxy services.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 10 operations across 6 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 0.0.1.

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

10 operations 6 paths 17 schemas 2 DELETE5 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

NetBird Services 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 6 paths, the API surfaces 10 operations — 2 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Services 10

Interact with and view information about reverse proxy services.

GET
/api/reverse-proxies/clusters
List available proxy clusters
→ 200401403500
GET
/api/reverse-proxies/services
List all Services
→ 200401403500
POST
/api/reverse-proxies/services
Create a Service
body → 200400401403409500
GET
/api/reverse-proxies/services/{serviceId}
Retrieve a Service
1 param → 200400401403404500
PUT
/api/reverse-proxies/services/{serviceId}
Update a Service
1 param body → 200400401403404409500
DELETE
/api/reverse-proxies/services/{serviceId}
Delete a Service
1 param → 200400401403404500
GET
/api/reverse-proxies/domains
Retrieve Service Domains
→ 200400401403404500
POST
/api/reverse-proxies/domains
Create a Custom domain
body → 200400401403404500
DELETE
/api/reverse-proxies/domains/{domainId}
Delete a Custom domain
1 param → 204400401403404500
GET
/api/reverse-proxies/domains/{domainId}/validate
Validate a custom domain
1 param → 202400401403404500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Service (15 properties), ServiceRequest (10 properties), ServiceTarget (8 properties), ReverseProxyDomain (8 properties). Each schema is shown below with its type and property counts.

ReverseProxyDomainType
string
Type of Reverse Proxy Domain
ReverseProxyDomain
object
8 properties 4 required
ServiceAuthConfig
object
5 properties
ProxyCluster
object
A proxy cluster represents a group of proxy nodes serving the same address
2 properties 2 required
BearerAuthConfig
object
2 properties 1 required
ServiceRequest
object
10 properties 3 required
ErrorResponse
object
Standard error response. Note: The exact structure of this error response is inferred from util.WriteErrorResponse and util.WriteError usage in the provided Go…
1 property
LinkAuthConfig
object
1 property 1 required
PINAuthConfig
object
2 properties 2 required
ServiceTarget
object
8 properties 5 required
ReverseProxyDomainRequest
object
2 properties 2 required
AccessRestrictions
object
Connection-level access restrictions based on IP address or geography. Applies to both HTTP and L4 services.
5 properties
Service
object
15 properties 7 required
PasswordAuthConfig
object
2 properties 2 required
ServiceMeta
object
3 properties 2 required
ServiceTargetOptions
object
6 properties
HeaderAuthConfig
object
Static header-value authentication. The proxy checks that the named header matches the configured value.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-services-api-openapi.yml Raw ↑

Other APIs NetBird publishes across the network.

NetBird Accounts API
AE Profile APIs.io
NetBird AWS Marketplace API
AE Profile APIs.io
NetBird Checkout API
AE Profile APIs.io
NetBird DNS API
AE Profile APIs.io
NetBird DNS Zones API
AE Profile APIs.io
NetBird EDR Falcon Integrations API
AE Profile APIs.io
NetBird EDR FleetDM Integrations API
AE Profile APIs.io
NetBird EDR Huntress Integrations API
AE Profile APIs.io
NetBird EDR Intune Integrations API
AE Profile APIs.io
NetBird EDR Peers API
AE Profile APIs.io
NetBird EDR SentinelOne Integrations API
AE Profile APIs.io
NetBird Event Streaming Integrations API
AE Profile APIs.io
#Services
← Back to N APIs
API Details
ID
netbird:netbird-services-api
Base URL
https://api.netbird.io
Docs
https://docs.netbird.io/
Provider
NetBird
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=netbird-services-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/netbird-services-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of NetBird Services API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.