Changelog¶

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.3.0] - 2026-03-31¶

MCP Server (netbird.mcp.server) — 25 NetBird management tools exposed via Model Context Protocol
- AI assistants (Claude Desktop, etc.) can now manage NetBird resources through natural language
- Tools cover: account, users, peers, groups, policies, networks, setup keys, DNS, posture checks, audit events, network diagrams
- See MCP Server for setup instructions
``mcp`` optional dependency — mcp[cli]>=1.0.0 via pip install "netbird[mcp]"
``netbird-mcp`` CLI entry point — Start the MCP server from the command line

PolicyRule sources / destinations — Changed type from List[Dict] to List[Union[str, Dict]]. The NetBird API expects plain string group IDs on writes (POST/PUT) but returns full objects on reads (GET).

New Resources:

Posture Checks (client.posture_checks) - Device compliance verification
Geo Locations (client.geo_locations) - Geographic data queries
DNS Zones (client.dns_zones) - Custom DNS zone and record management
Identity Providers (client.identity_providers) - OAuth2/OIDC provider management
Instance (client.instance) - Instance status, version, and setup

Cloud Namespace (client.cloud.*):

Services - Reverse proxy service and domain management
Ingress - Ingress port allocation and peer management
EDR - Endpoint Detection & Response integrations:
- client.cloud.edr.peers - EDR peer bypass management
- client.cloud.edr.falcon - CrowdStrike Falcon
- client.cloud.edr.huntress - Huntress
- client.cloud.edr.intune - Microsoft Intune
- client.cloud.edr.sentinelone - SentinelOne
MSP - Multi-tenant management for MSPs
Invoices - Billing invoice retrieval (PDF/CSV)
Usage - Billing usage statistics
Event Streaming - Event streaming integrations (Datadog, S3, etc.)
IDP/SCIM - SCIM identity provider integrations

Existing Resource Enhancements:

Users - approve, reject, change_password, invite management
Peers - create_temporary_access, job management
Events - get_proxy_events with 16 filter parameters
Networks - list_all_routers for global router listing
Account Settings - New fields for peer inactivity, DNS resolution, network range
PolicyRule - port_ranges, authorized_groups, resource fields with camelCase aliases

BaseModel - Changed Pydantic extra from "forbid" to "allow" for forward compatibility
Routes API - All methods now emit DeprecationWarning (use Networks API instead)
_parse_list_response - Handles null API responses gracefully
Cloud-only endpoint detection with UserWarning for self-hosted instances

Event Streaming endpoint path (event-streaming -> integrations/event-streaming)
Null list responses from API now return empty lists

Removed use_ssl parameter (always uses HTTPS, pass http:// prefix for non-SSL)
Switched documentation from Jekyll to Sphinx with Furo theme
Cleaned up diagram test files