APIActive

NetBird REST API

NetBird Public API for managing users, peers, network rules, and more.

Field note

What it does

Use the NetBird Public API to manage users, peers, network rules and more from inside your application or scripts to automate the setup of your mesh network.

Capabilities

Available capabilities

Network Management User Management Policy Management DNS management Authentication Peer Management

Bearer Token Authentication

Authenticate using Bearer token from identity provider or personal access token.

Personal Access Tokens

Create personal access tokens in the NetBird dashboard.

Resource Management

Manage accounts, users, tokens, peers, setup keys, groups, networks, policies, routes, DNS, and events.

Service User Support

Recommended to create a service user for API communication.