Skip to main content
Creating a service user needs the Owner or Admin role. Give the service user the Auditor role if you only read data. NetBird says: “An Auditor can read every configuration in the account but can’t modify anything.” Actions that create, update or delete need the Admin role, and deleting the account needs the Owner role.

Find your server URL

The Server URL is the address of your own NetBird management server. NetBird Cloud needs none.

  • On NetBird Cloud, leave Server URL empty. StackOne then uses https://api.netbird.io.
  • For a self-hosted NetBird, copy the scheme and host name you open the NetBird dashboard on, without any path such as /peers.
  • Format: https://{domain}, with :{port} added if your address has one
  • Example: https://netbird.example.com
  • The connection always uses HTTPS, with or without the scheme or a trailing slash.
  • A self-hosted server needs NetBird v0.44 or later.
  • Paste the address into the Server URL field in StackOne Hub.

Create a service user

A service user is a non-interactive account that owns the token, so the connection does not depend on a person’s account. Create it on the account you want to review.

1

Sign in to NetBird

Sign in to your organization’s NetBird Cloud account as an Owner or Admin. For a self-hosted NetBird, sign in to your NetBird instance at the address you found above.

  • Navigate to Team -> Service Users.
NetBird sign-in page with the email field and the Continue button
2

Create the service user

Click Create Service User and enter a name such as StackOne Integration.

  • The role list starts on User. Change it to Auditor to only read. It reads every configuration, including users, groups and activity, and cannot change anything.
  • Choose Admin to also create, update and delete users, groups, peers, policies, networks, routes, DNS and other settings. An Auditor token gets 403 on those actions.
  • Auditor lists only this service user’s own access tokens. NetBird shows the access tokens of other service users only to an Admin or Owner, and a person’s tokens only to that person.
  • Admin also lists the access tokens of other service users.
  • Click Create Service User.

Create the access token

The token has the role of its service user. With Auditor it cannot change anything.

1

Open the service user

In Service Users, click the service user you created.

2

Create the token

Click Create Access Token.

  • Name: StackOne Integration
  • In Expires in, enter how many days the token stays valid, from 1 to 365. The field starts at 30. NetBird has no token that never expires.
  • When the token expires, the connection stops working until you paste a new token into StackOne Hub. You cannot change a token after you create it.
  • Click Create Token.
3

Copy the token

Click Copy to clipboard and store the token securely for use later.

  • The token is only shown once and cannot be retrieved later. NetBird says “This token will not be shown again, so be sure to copy it and store in a secure location.” NetBird stores only a hash of the token.
  • Paste it into the Access Token field in StackOne Hub.

Use a person’s token instead

A personal access token also works if the person’s role can read users, such as Auditor, Admin or Owner. A Billing Admin token reads only that person, so the connection is refused. A token of a person in a managed service provider account reads that person’s default account.

1

Open your user

Navigate to Team -> Users and click your own user. NetBird marks it YOU.

Team > Users page listing the signed-in user
2

Create the token

Open the Access Tokens tab and click Create Access Token.

  • Fill in Name and Expires in as for a service user, then click Create Token.
  • Click Copy to clipboard and paste the token into the Access Token field in StackOne Hub.
User page with the Access Tokens tab and the Create Access Token button

Limits and revoking access

On NetBird Cloud, NetBird limits API use to 120 requests per minute with a burst of 1200. To stop StackOne using your account, open the service user under Team -> Service Users and delete the token, or delete the service user.

1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Next Steps

Webhooks setup

Configure receiving Events for NetBird into StackOne.