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

NetBird Peers API

Interact with and view information about peers.

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

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

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

6 operations 4 paths 11 schemas 1 DELETE3 GET1 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 Peers 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 6

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

Peers 6

Interact with and view information about peers.

GET
/api/peers
List all Peers
2 params → 200400401403500
GET
/api/peers/{peerId}
Retrieve a Peer
1 param → 200400401403500
PUT
/api/peers/{peerId}
Update a Peer
1 param body → 200400401403500
DELETE
/api/peers/{peerId}
Delete a Peer
1 param → 200400401403500
GET
/api/peers/{peerId}/accessible-peers
List accessible Peers
1 param → 200400401403500
POST
/api/peers/{peerId}/temporary-access
Create a Temporary Access Peer
1 param body → 200400401403500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are PeerLocalFlags (10 properties), PeerRequest (6 properties), GroupMinimum (5 properties), PeerTemporaryAccessResponse (3 properties). Each schema is shown below with its type and property counts.

PeerBatch
PeerMinimum
object
2 properties 2 required
PeerLocalFlags
object
10 properties
CountryCode
string
2-letter ISO 3166-1 alpha-2 code that represents the country
PeerRequest
object
6 properties 4 required
Peer
PeerTemporaryAccessRequest
object
3 properties 3 required
AccessiblePeer
GroupMinimum
object
5 properties 4 required
CityName
string
Commonly used English name of the city
PeerTemporaryAccessResponse
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-peers-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
Where this information came from

This is an independent, third-party profile of NetBird Peers 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.