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 Event Streaming Integrations API

Manage event streaming integrations.

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

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

This API exposes 5 operations across 2 paths, and defines 3 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.

5 operations 2 paths 3 schemas 1 DELETE2 GET1 POST1 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 Event Streaming Integrations 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 5

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

Event Streaming Integrations 5

Manage event streaming integrations.

POST
/api/event-streaming
Create Event Streaming Integration
createIntegration body → 200400401500
GET
/api/event-streaming
List Event Streaming Integrations
getAllIntegrations → 200401500
GET
/api/event-streaming/{id}
Get Event Streaming Integration
getIntegration 1 param → 200400401404500
PUT
/api/event-streaming/{id}
Update Event Streaming Integration
updateIntegration 1 param body → 200400401404500
DELETE
/api/event-streaming/{id}
Delete Event Streaming Integration
deleteIntegration 1 param → 200400401404500

Schemas 3

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

IntegrationResponse
object
Represents an event streaming integration.
7 properties
CreateIntegrationRequest
object
Request payload for creating a new event streaming integration. Also used as the structure for the PUT request body, but not all fields are applicable for upda…
3 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-event-streaming-integrations-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 Events API