add PAT rate limiting info (#514)

This commit is contained in:
Pascal Fischer
2025-12-10 19:46:48 +01:00
committed by GitHub
parent 3d21a987a8
commit 3e972e816c
2 changed files with 9 additions and 0 deletions

View File

@@ -1,3 +1,4 @@
import {Note} from "../../../components/mdx";
export const description =
'In this guide, well look at how authentication works. NetBird offers two ways to authenticate your API requests: OAuth2 and personal access tokens.'
@@ -20,6 +21,10 @@ Always keep your token safe and reset it if you suspect it has been compromised.
When establishing a connection using [PATs](/manage/public-api), you will need your access token — you can create one in the [NetBird dashboard](https://app.netbird.io/users) under User settings. It is recommended to use [service users](/manage/public-api) for all organization wide flows calling the API. Here's how to add the token to the request header using cURL:
<Note>
For the cloud solution we are limiting the usage to 120 requests per minute with burst of 1200 requests. If your workload requires more requests, please contact us at [support@netbird.io](mailto:support@netbird.io).
</Note>
```bash {{ title: 'Example request with personal access token' }}
curl https://api.netbird.io/api/users \
-H "Authorization: Token {token}"