sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-10-09 15:19:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update API pages with v0.81.0-canary.pr-7395.1

Browse Source
This commit is contained in:
netbirddev
2026-10-06 15:47:53 +00:00
parent 4a9435e701
commit 2bd1f37018
4 changed files with 207 additions and 2482 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pages/ipa/resources/agent-network.mdx
+2 -2
View File
@@ -6,7 +6,7 @@ export const title = 'Agent Network'
<Row>
<Col>
Starts provisioning of a NetBird-managed Agent Network gateway for the account, allocating its endpoint under the managed zone on the first call. Idempotent — answers 202 when this call started (or, after a failure, restarted) provisioning and 200 when a deployment already exists, reporting current state either way. Returns 409 when the account already has an Agent Network endpoint that managed provisioning does not own, and 503 when endpoint allocation is temporarily exhausted.
Starts provisioning of a NetBird-managed Agent Network gateway for the account, allocating its endpoint under the managed zone on the first call. Idempotent — answers 202 when this call started (or, after a failure, restarted) provisioning and 200 when a deployment already exists, reporting current state either way. A disabled deployment answers 200 with state `disabled` and stays disabled. Returns 409 when the account already has an Agent Network endpoint that managed provisioning does not own, and 503 when endpoint allocation is temporarily exhausted.
</Col>
<Col sticky>
@@ -194,7 +194,7 @@ echo $response;
<Row>
<Col>
Reports the account's managed gateway deployment and its derived state. Returns 404 when the account has no managed deployment.
Reports the account's managed gateway deployment and its derived state, including `disabled` for a deployment that is turned off. Returns 404 when the account has no managed deployment.
</Col>
<Col sticky>
src/pages/ipa/resources/ingress-ports.mdx
-2480
View File
File diff suppressed because it is too large Load Diff
src/pages/ipa/resources/msp.mdx
+165
View File
@@ -845,6 +845,171 @@ echo $response;
---
## Delete MSP tenant {{ tag: 'DELETE' , label: '/api/integrations/msp/tenants/{id}' }}
<Row>
<Col>
### Path Parameters
<Properties>
<Property name="id" type="string" required={true}>
The unique identifier of a tenant account
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/integrations/msp/tenants/{id}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/integrations/msp/tenants/{id} \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'delete',
maxBodyLength: Infinity,
url: '/api/integrations/msp/tenants/{id}',
headers: {
'Authorization': 'Token <TOKEN>'
}
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/integrations/msp/tenants/{id}"
headers = {
'Authorization': 'Token <TOKEN>'
}
response = requests.request("DELETE", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/integrations/msp/tenants/{id}"
method := "DELETE"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/integrations/msp/tenants/{id}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = "Token <TOKEN>"
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.netbird.io/api/integrations/msp/tenants/{id}")
.method("DELETE")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/integrations/msp/tenants/{id}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
</Col>
</Row>
---
## Unlink a tenant {{ tag: 'POST' , label: '/api/integrations/msp/tenants/{id}/unlink' }}
<Row>
src/pages/ipa/resources/peers.mdx
+40
View File
@@ -18,6 +18,10 @@ export const title = 'Peers'
<Property name="ip" type="string" required={false}>
Filter peers by IP address
</Property>
<Property name="mac" type="string" required={false}>
Filter peers by MAC address of a network interface
</Property>
</Properties>
</Col>
@@ -180,6 +184,12 @@ echo $response;
"created_at": "2023-05-05T09:00:35.477782Z",
"ip": "10.64.0.1",
"ipv6": "fd00:4e42:ab12::1",
"network_addresses": [
{
"net_ip": "192.168.0.11/24",
"mac": "00:93:37:bd:83:0f"
}
],
"connection_ip": "35.64.0.1",
"connected": true,
"last_seen": "2023-05-05T10:05:26.420578Z",
@@ -242,6 +252,12 @@ echo $response;
"created_at": "string",
"ip": "string",
"ipv6": "string",
"network_addresses": [
{
"net_ip": "string",
"mac": "string"
}
],
"connection_ip": "string",
"connected": "boolean",
"last_seen": "string",
@@ -475,6 +491,12 @@ echo $response;
"created_at": "2023-05-05T09:00:35.477782Z",
"ip": "10.64.0.1",
"ipv6": "fd00:4e42:ab12::1",
"network_addresses": [
{
"net_ip": "192.168.0.11/24",
"mac": "00:93:37:bd:83:0f"
}
],
"connection_ip": "35.64.0.1",
"connected": true,
"last_seen": "2023-05-05T10:05:26.420578Z",
@@ -534,6 +556,12 @@ echo $response;
"created_at": "string",
"ip": "string",
"ipv6": "string",
"network_addresses": [
{
"net_ip": "string",
"mac": "string"
}
],
"connection_ip": "string",
"connected": "boolean",
"last_seen": "string",
@@ -875,6 +903,12 @@ echo $response;
"created_at": "2023-05-05T09:00:35.477782Z",
"ip": "10.64.0.1",
"ipv6": "fd00:4e42:ab12::1",
"network_addresses": [
{
"net_ip": "192.168.0.11/24",
"mac": "00:93:37:bd:83:0f"
}
],
"connection_ip": "35.64.0.1",
"connected": true,
"last_seen": "2023-05-05T10:05:26.420578Z",
@@ -934,6 +968,12 @@ echo $response;
"created_at": "string",
"ip": "string",
"ipv6": "string",
"network_addresses": [
{
"net_ip": "string",
"mac": "string"
}
],
"connection_ip": "string",
"connected": "boolean",
"last_seen": "string",