NetBird REST API
API to manipulate groups, rules, policies and retrieve information about peers and users
What You Can Do
MCP Tools
get-api-instance
Get Instance Status
get-api-instance-version
Get Version Info
post-api-setup
Setup Instance
get-api-peers-peerid-jobs
List Jobs
post-api-peers-peerid-jobs
Create Job
get-api-peers-peerid-jobs-jobid
Get Job
get-api-accounts
List all Accounts
delete-api-accounts-accountid
Delete an Account
put-api-accounts-accountid
Update an Account
get-api-users
List all Users
post-api-users
Create a User
put-api-users-userid
Update a User
delete-api-users-userid
Delete a User
get-api-users-userid-tokens
List all Tokens
post-api-users-userid-tokens
Create a Token
get-api-users-userid-tokens-tokenid
Retrieve a Token
delete-api-users-userid-tokens-tokenid
Delete a Token
post-api-users-userid-invite
Resend user invitation
post-api-users-userid-approve
Approve user
delete-api-users-userid-reject
Reject user
put-api-users-userid-password
Change user password
get-api-users-current
Retrieve current user
get-api-users-invites
List user invites
post-api-users-invites
Create a user invite
delete-api-users-invites-inviteid
Delete a user invite
post-api-users-invites-inviteid-regenerate
Regenerate a user invite
get-api-users-invites-token
Get invite information
post-api-users-invites-token-accept
Accept an invite
get-api-peers
List all Peers
get-api-peers-peerid
Retrieve a Peer
put-api-peers-peerid
Update a Peer
delete-api-peers-peerid
Delete a Peer
get-api-peers-peerid-accessible-peers
List accessible Peers
post-api-peers-peerid-temporary-access
Create a Temporary Access Peer
get-api-peers-peerid-ingress-ports
List all Port Allocations
post-api-peers-peerid-ingress-ports
Create a Port Allocation
get-api-peers-peerid-ingress-ports-allocationid
Retrieve a Port Allocation
put-api-peers-peerid-ingress-ports-allocationid
Update a Port Allocation
delete-api-peers-peerid-ingress-ports-allocation
Delete a Port Allocation
get-api-ingress-peers
List all Ingress Peers
post-api-ingress-peers
Create a Ingress Peer
get-api-ingress-peers-ingresspeerid
Retrieve a Ingress Peer
put-api-ingress-peers-ingresspeerid
Update a Ingress Peer
delete-api-ingress-peers-ingresspeerid
Delete a Ingress Peer
get-api-setup-keys
List all Setup Keys
post-api-setup-keys
Create a Setup Key
get-api-setup-keys-keyid
Retrieve a Setup Key
put-api-setup-keys-keyid
Update a Setup Key
delete-api-setup-keys-keyid
Delete a Setup Key
get-api-groups
List all Groups
post-api-groups
Create a Group
get-api-groups-groupid
Retrieve a Group
put-api-groups-groupid
Update a Group
delete-api-groups-groupid
Delete a Group
get-api-policies
List all Policies
post-api-policies
Create a Policy
get-api-policies-policyid
Retrieve a Policy
put-api-policies-policyid
Update a Policy
delete-api-policies-policyid
Delete a Policy
get-api-routes
List all Routes