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

Manage notification channels for account event alerts.

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

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

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

Notifications 6

Manage notification channels for account event alerts.

GET
/api/integrations/notifications/types
List Notification Event Types
listNotificationEventTypes → 200400401403404500
GET
/api/integrations/notifications/channels
List Notification Channels
listNotificationChannels → 200400401403404500
POST
/api/integrations/notifications/channels
Create Notification Channel
createNotificationChannel body → 200400401403404500
GET
/api/integrations/notifications/channels/{channelId}
Get Notification Channel
getNotificationChannel 1 param → 200400401403404500
PUT
/api/integrations/notifications/channels/{channelId}
Update Notification Channel
updateNotificationChannel 1 param body → 200400401403404500
DELETE
/api/integrations/notifications/channels/{channelId}
Delete Notification Channel
deleteNotificationChannel 1 param → 200400401403404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are NotificationChannelResponse (5 properties), NotificationChannelRequest (4 properties), WebhookTarget (2 properties), EmailTarget (1 property). Each schema is shown below with its type and property counts.

NotificationEventType
string
An activity event type code. See GET /api/integrations/notifications/types for the full list of supported event types and their human-readable descriptions.
NotificationChannelResponse
object
A notification channel configuration.
5 properties 4 required
NotificationTypeEntry
object
A map of event type codes to their human-readable descriptions.
WebhookTarget
object
Target configuration for webhook notification channels.
2 properties 1 required
NotificationChannelRequest
object
Request body for creating or updating a notification channel.
4 properties 3 required
EmailTarget
object
Target configuration for email notification channels.
1 property 1 required
NotificationChannelType
string
The type of notification channel.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-notifications-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 Notifications 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.