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.
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.
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. It reads every configuration, including users, groups and activity, and cannot change anything.
- 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.
- Choose Admin only if you need the access tokens of other service users. Admin also manages users, peers, networks and account settings.
- Click Create Service User.
Create the access token
Any service user can read the whole account. Use one with the Auditor role, so the token cannot change anything.
Open the service user
In Service Users, click the service user you created.
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.
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. Create it the same way on your own user under Team -> Users. 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.
Limits and revoking access
On NetBird Cloud, NetBird limits API use to 120 requests per minute with a burst of 1200. To stop StackOne reading your account, open the service user under Team -> Service Users and delete the token, or delete the service user.
Linking the Account from the Hub
Navigate to the Hub
Fill out the fields
- Access Token
- Server URL (Optional)
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
If the account linking is successful, you will see the newly linked account on your Accounts page.