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

View information about the account and network events.

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

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

This API exposes 3 operations across 3 paths, and defines 11 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 3 paths 11 schemas 3 GET

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 Events 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 — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Events 3

View information about the account and network events.

GET
/api/events/audit
List all Audit Events
→ 200400401403500
GET
/api/events/network-traffic
List all Traffic Events
11 params → 200400401403500
GET
/api/events/proxy
List all Reverse Proxy Access Logs
16 params → 200401403500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ProxyAccessLog (19 properties), NetworkTrafficEvent (14 properties), Event (9 properties), NetworkTrafficEndpoint (7 properties). Each schema is shown below with its type and property counts.

NetworkTrafficEndpoint
object
7 properties 7 required
NetworkTrafficEvent
object
14 properties 16 required
NetworkTrafficSubEvent
object
2 properties 2 required
NetworkTrafficUser
object
3 properties 3 required
NetworkTrafficPolicy
object
2 properties 2 required
NetworkTrafficEventsResponse
object
5 properties 5 required
ProxyAccessLog
object
19 properties 10 required
NetworkTrafficLocation
object
2 properties 2 required
ProxyAccessLogsResponse
object
5 properties 5 required
NetworkTrafficICMP
object
2 properties 2 required
Event
object
9 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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