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 EDR Peers API

Manage EDR compliance bypass for peers.

NetBird EDR 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 EDR Peers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 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.

3 operations 2 paths 2 schemas 1 DELETE1 GET1 POST

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 EDR 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 3

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

EDR Peers 3

Manage EDR compliance bypass for peers.

POST
/api/peers/{peer-id}/edr/bypass
Bypass compliance for a non-compliant peer
bypassCompliance 1 param → 200400401403500
DELETE
/api/peers/{peer-id}/edr/bypass
Revoke compliance bypass for a peer
revokeBypass 1 param → 200401403500
GET
/api/peers/edr/bypassed
List all bypassed peers
listBypassedPeers → 200401403500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (1 property), BypassResponse (1 property). Each schema is shown below with its type and property counts.

BypassResponse
object
Response for bypassed peer operations.
1 property 1 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-edr-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 SentinelOne Integrations API
NetBird Event Streaming Integrations API
NetBird Events API