NetBird REST API
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.
Getting started
To get started, it is recommended to create a service user, that can later be used to communicate with the NetBird API. To be able to send requests to our API you need to authenticate on each request. This can be done either by Bearer token from your identity provider or by creating a personal access token in the NetBird dashboard.
Resources
Accounts
Learn how to list and update accounts.
Users
Learn how to create, update, delete, and list users.
Tokens
Learn how to create, retrieve, delete, and list tokens.
Peers
Learn how to retrieve, update, delete, and list peers.
Setup Keys
Learn how to create, retrieve, update, and list setup keys.
Groups
Learn how to create, retrieve, update, delete, and list groups.
Rules
Learn how to create, retrieve, update, delete, and list rules.
Policies
Learn how to create, retrieve, update, delete, and list policies.
Routes
Learn about how to create, retrieve, update, delete, and list routes.
DNS
Learn about how to create, retrieve, update, delete, and list nameserver groups and update and retrieve DNS settings.
Events
Learn about how to list events.