Examples

Practical examples showing common use cases with the NetBird Python client.

• User Management
  • List All Users
  • Get Current User
  • Create Users
  • Update User Role
  • Approve or Reject Users
  • User Invites
  • Token Management
  • Bulk User Operations
  • Block/Unblock Users
  • Delete Users
• Network Management
  • Peer Management
  • Group Management
  • Network Management
  • Policy Management
  • Setup Keys
  • DNS Management
  • Posture Checks
  • Events and Monitoring
  • Geographic Data
• Network Diagrams
  • Mermaid Diagrams
  • Graphviz Diagrams
  • Python Diagrams
  • Customizing Diagrams
  • Working with Network Map Data
  • Export to JSON

Getting Started

All examples assume you have initialized the client:

from netbird import APIClient

client = APIClient(
    host="api.netbird.io",
    api_token="your-api-token"
)

Quick Examples

List All Peers

peers = client.peers.list()
for peer in peers:
    status = "online" if peer["connected"] else "offline"
    print(f"{peer['name']:20s} {peer['ip']:15s} {status}")

Get Account Info

accounts = client.accounts.list()
for account in accounts:
    print(f"Account: {account['id']}")
    print(f"Domain: {account.get('domain', 'N/A')}")

List Groups with Peer Counts

groups = client.groups.list()
for group in sorted(groups, key=lambda g: g['name']):
    peers = group.get('peers', [])
    print(f"{group['name']}: {len(peers)} peers")

Monitor Audit Events

events = client.events.get_audit_events()
for event in events[-10:]:
    print(f"[{event['timestamp']}] {event['activity']}")

Export Network Data

import json

# Export peers
peers = client.peers.list()
with open("peers.json", "w") as f:
    json.dump(peers, f, indent=2)

# Export groups
groups = client.groups.list()
with open("groups.json", "w") as f:
    json.dump(groups, f, indent=2)

Cloud Resources

# These only work with NetBird Cloud (api.netbird.io)

# Get usage statistics
usage = client.cloud.usage.get()
print(f"Active peers: {usage.get('active_peers', 'N/A')}")

# List reverse proxy services
services = client.cloud.services.list()
for svc in services:
    print(f"Service: {svc['name']}")

# Check EDR integrations
try:
    falcon = client.cloud.edr.falcon.get()
    print(f"Falcon: {falcon}")
except Exception:
    print("Falcon not configured")