Final Doc Restructure (#497)

This commit is contained in:
Brandon Hopkins
2025-11-27 09:50:03 -08:00
committed by GitHub
parent 846cae1fb0
commit e45bb7ce11
372 changed files with 353 additions and 536 deletions

View File

@@ -18,7 +18,7 @@ Always keep your token safe and reset it if you suspect it has been compromised.
## Using personal access tokens
When establishing a connection using [PATs](/how-to/access-netbird-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](/how-to/access-netbird-public-api) for all organization wide flows calling the API. Here's how to add the token to the request header using cURL:
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:
```bash {{ title: 'Example request with personal access token' }}
curl https://api.netbird.io/api/users \
@@ -28,6 +28,6 @@ curl https://api.netbird.io/api/users \
Always keep your token safe and reset it if you suspect it has been compromised.
<div className="not-prose mb-16 mt-6 flex gap-3">
<Button href="/how-to/access-netbird-public-api#creating-an-access-token" arrow="right" children="How to create tokens" />
<Button href="/manage/public-api#creating-an-access-token" arrow="right" children="How to create tokens" />
</div>

View File

@@ -14,12 +14,12 @@ Use the NetBird Public API to manage users, peers, network rules and more from i
## Getting started {{ anchor: false }}
To get started, it is recommended to create a [service user](/how-to/access-netbird-public-api#creating-a-service-user), that can later be used to communicate with the NetBird API.
To get started, it is recommended to create a [service user](/manage/public-api#creating-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](/api/guides/authentication) on each request. This can be done either by Bearer token from your identity provider or by creating a [personal access token](/api/guides/authentication#using-personal-access-tokens) in the NetBird dashboard.{{ className: 'lead' }}
<div className="not-prose">
<Button
href="/how-to/access-netbird-public-api#creating-an-access-token"
href="/manage/public-api#creating-an-access-token"
variant="text"
arrow="right"
children="Get your personal access token"