sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-16 15:36:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5e27b0f37e7b912e26386fbc8dda5e926996b7c0
netbird-docs/generator/api-back.mdx
Pascal Fischer 86b1890396 add first version of tailwind docs
2023-05-03 19:00:56 +02:00

5334 lines
89 KiB
Plaintext
Raw Blame History

---
id: usage
slug: /usage
title: Usage
toc_max_heading_level: 3
---
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
API to manipulate groups, rules, policies and retrieve information about peers and users
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
## Users [#users]
Interact with and view information about users.
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Retrieve Users [#retrieve-users]
```
GET https://api.netbird.io/api/users
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON array of Users
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Create a User [#create-a-user]
```
POST https://api.netbird.io/api/users
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/UserCreateRequest"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A User object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/User"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Update a User [#update-a-user]
```
PUT https://api.netbird.io/api/users/{userId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
userId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a user
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/UserRequest"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A User object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/User"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Delete a User [#delete-a-user]
```
DELETE https://api.netbird.io/api/users/{userId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
userId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a user
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
Delete status code
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### List all Tokens [#list-all-tokens]
```
GET https://api.netbird.io/api/users/{userId}/tokens
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
userId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a user
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON Array of PersonalAccessTokens
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PersonalAccessToken"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Create a Token [#create-a-token]
```
POST https://api.netbird.io/api/users/{userId}/tokens
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
userId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a user
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/PersonalAccessTokenRequest"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
The token in plain text
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/PersonalAccessTokenGenerated"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Retrieve a Token [#retrieve-a-token]
```
GET https://api.netbird.io/api/users/{userId}/tokens/{tokenId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
userId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a user
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
tokenId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a token
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A PersonalAccessTokens Object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/PersonalAccessToken"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Delete a Token [#delete-a-token]
```
DELETE https://api.netbird.io/api/users/{userId}/tokens/{tokenId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
userId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a user
</div>
</li>
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
tokenId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a token
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
Delete status code
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
## Peers [#peers]
Interact with and view information about peers.
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### List all Peers [#list-all-peers]
```
GET https://api.netbird.io/api/peers
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON Array of Peers
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Peer"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Retrieve a Peer [#retrieve-a-peer]
```
GET https://api.netbird.io/api/peers/{peerId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
peerId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a peer
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Peer object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Peer"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Update a Peer [#update-a-peer]
```
PUT https://api.netbird.io/api/peers/{peerId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
peerId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a peer
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/peers_peerId_body"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Peer object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Peer"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Delete a Peer [#delete-a-peer]
```
DELETE https://api.netbird.io/api/peers/{peerId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
peerId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a peer
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
Delete status code
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
## Setup Keys [#setup-keys]
Interact with and view information about setup keys.
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### List all Setup Keys [#list-all-setup-keys]
```
GET https://api.netbird.io/api/setup-keys
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON Array of Setup keys
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SetupKey"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Create a Setup Key [#create-a-setup-key]
```
POST https://api.netbird.io/api/setup-keys
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/SetupKeyRequest"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Setup Keys Object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/SetupKey"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Retrieve a Setup Key [#retrieve-a-setup-key]
```
GET https://api.netbird.io/api/setup-keys/{keyId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
keyId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a setup key
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Setup Key object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/SetupKey"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Update a Setup Key [#update-a-setup-key]
```
PUT https://api.netbird.io/api/setup-keys/{keyId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
keyId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a setup key
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/SetupKeyRequest"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Setup Key object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/SetupKey"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
## Groups [#groups]
Interact with and view information about groups.
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### List all Groups [#list-all-groups]
```
GET https://api.netbird.io/api/groups
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON Array of Groups
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Create a Group [#create-a-group]
```
POST https://api.netbird.io/api/groups
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/api_groups_body"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Group Object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Group"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Retrieve a Group [#retrieve-a-group]
```
GET https://api.netbird.io/api/groups/{groupId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
groupId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a group
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Group object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Group"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Update a Group [#update-a-group]
```
PUT https://api.netbird.io/api/groups/{groupId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
groupId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a group
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/groups_groupId_body"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Group object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Group"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Delete a Group [#delete-a-group]
```
DELETE https://api.netbird.io/api/groups/{groupId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
groupId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a group
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
Delete status code
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
## Rules [#rules]
Interact with and view information about rules.
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### List all Rules [#list-all-rules]
```
GET https://api.netbird.io/api/rules
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON Array of Rules
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rule"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Create a Rule [#create-a-rule]
```
POST https://api.netbird.io/api/rules
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/api_rules_body"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Rule Object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Retrieve a Rule [#retrieve-a-rule]
```
GET https://api.netbird.io/api/rules/{ruleId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
ruleId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a rule
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Rule object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Update a Rule [#update-a-rule]
```
PUT https://api.netbird.io/api/rules/{ruleId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
ruleId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a rule
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/rules_ruleId_body"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Rule object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Rule"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Delete a Rule [#delete-a-rule]
```
DELETE https://api.netbird.io/api/rules/{ruleId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
ruleId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a rule
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
Delete status code
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
## Policies [#policies]
Interact with and view information about policies.
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### List all Policies [#list-all-policies]
```
GET https://api.netbird.io/api/policies
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON Array of Policies
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Policy"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Create a Policy [#create-a-policy]
```
POST https://api.netbird.io/api/policies
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/api_policies_body"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Policy Object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Policy"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Retrieve a Policy [#retrieve-a-policy]
```
GET https://api.netbird.io/api/policies/{policyId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
policyId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a policy
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Policy object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Policy"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Update a Policy [#update-a-policy]
```
PUT https://api.netbird.io/api/policies/{policyId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
policyId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a policy
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/policies_policyId_body"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Policy object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Policy"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Delete a Policy [#delete-a-policy]
```
DELETE https://api.netbird.io/api/policies/{policyId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
policyId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a policy
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
Delete status code
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
## Routes [#routes]
Interact with and view information about routes.
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### List all Routes [#list-all-routes]
```
GET https://api.netbird.io/api/routes
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON Array of Routes
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Route"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Create a Route [#create-a-route]
```
POST https://api.netbird.io/api/routes
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/RouteRequest"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Route Object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Route"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Retrieve a Route [#retrieve-a-route]
```
GET https://api.netbird.io/api/routes/{routeId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
routeId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a route
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Route object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Route"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Update a Route [#update-a-route]
```
PUT https://api.netbird.io/api/routes/{routeId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
routeId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a route
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/RouteRequest"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Route object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Route"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Delete a Route [#delete-a-route]
```
DELETE https://api.netbird.io/api/routes/{routeId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
routeId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a route
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
Delete status code
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
## DNS [#dns]
Interact with and view information about DNS configuration.
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### List all Nameserver Groups [#list-all-nameserver-groups]
```
GET https://api.netbird.io/api/dns/nameservers
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON Array of Nameserver Groups
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NameserverGroup"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Create a Nameserver Group [#create-a-nameserver-group]
```
POST https://api.netbird.io/api/dns/nameservers
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/NameserverGroupRequest"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Nameserver Groups Object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/NameserverGroup"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Retrieve a Nameserver Group [#retrieve-a-nameserver-group]
```
GET https://api.netbird.io/api/dns/nameservers/{nsgroupId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
nsgroupId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a Nameserver Group
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Nameserver Group object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/NameserverGroup"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Update a Nameserver Group [#update-a-nameserver-group]
```
PUT https://api.netbird.io/api/dns/nameservers/{nsgroupId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
nsgroupId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a Nameserver Group
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/NameserverGroupRequest"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A Nameserver Group object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/NameserverGroup"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Delete a Nameserver Group [#delete-a-nameserver-group]
```
DELETE https://api.netbird.io/api/dns/nameservers/{nsgroupId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
nsgroupId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of a Nameserver Group
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
Delete status code
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Retrieve DNS Settings [#retrieve-dns-settings]
```
GET https://api.netbird.io/api/dns/settings
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON Object of DNS Setting
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DNSSettings"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Update DNS Settings [#update-dns-settings]
```
PUT https://api.netbird.io/api/dns/settings
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/DNSSettings"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON Object of DNS Setting
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/DNSSettings"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
## Events [#events]
View information about the account and network events.
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### List all Events [#list-all-events]
```
GET https://api.netbird.io/api/events
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON Array of Events
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Event"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
## Accounts [#accounts]
View information about the accounts.
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### List all Accounts [#list-all-accounts]
```
GET https://api.netbird.io/api/accounts
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
A JSON array of accounts
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
### Update an Account [#update-an-account]
```
PUT https://api.netbird.io/api/accounts/{accountId}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Path Parameters
<ul className="method-list-group not-prose">
<li className="method-list-item">
<h4 className="method-list-item-label">
<span className="method-list-item-label-name">
accountId
</span>
<span className="method-list-item-label-badge">
required
</span>
<span className="method-list-item-validation">
</span>
</h4>
<div class="method-list-item-description">
The unique identifier of an account
</div>
</li>
</ul>
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Body Parameters
```json
{
"schema": {
"$ref": "#/components/schemas/accounts_accountId_body"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
#### Responses
<Tabs scrollable size="small" type="underlined" defaultActiveId="200">
<TabPanel id="200" label="200">
An Account object
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
```json
{
"schema": {
"$ref": "#/components/schemas/Account"
}
}
```
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="400" label="400">
Bad Request
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="401" label="401">
Requires authentication
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="403" label="403">
Forbidden
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
<TabPanel id="500" label="500">
Internal Server Error
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY IF THIS IS VERSION "next" -->
</TabPanel>
</Tabs>
<br />
Reference in New Issue View Git Blame Copy Permalink