mirror of
https://github.com/netbirdio/docs.git
synced 2026-10-17 02:59:04 +02:00
Update API pages with v0.81.0-rc.1
This commit is contained in:
@@ -201,6 +201,7 @@ echo $response;
|
||||
"auto_update_version": "0.51.2",
|
||||
"auto_update_always": false,
|
||||
"metrics_push_enabled": false,
|
||||
"peer_hostname_collision_rejected": false,
|
||||
"agent_network_only": false,
|
||||
"dashboard_features": {
|
||||
"agent_network": true
|
||||
@@ -260,6 +261,7 @@ echo $response;
|
||||
"auto_update_version": "string",
|
||||
"auto_update_always": "boolean",
|
||||
"metrics_push_enabled": "boolean",
|
||||
"peer_hostname_collision_rejected": "boolean",
|
||||
"agent_network_only": "boolean",
|
||||
"dashboard_features": {
|
||||
"agent_network": "boolean"
|
||||
@@ -609,6 +611,11 @@ echo $response;
|
||||
|
||||
Enables or disables client metrics push for all peers in the account
|
||||
|
||||
</Property>
|
||||
<Property name="peer_hostname_collision_rejected" type="boolean" required={false}>
|
||||
|
||||
When enabled, registering or renaming a peer to a hostname already used by another peer in the account fails instead of receiving an IP-based suffix. Applies to ephemeral peers as well.
|
||||
|
||||
</Property>
|
||||
<Property name="agent_network_only" type="boolean" required={false}>
|
||||
|
||||
@@ -730,6 +737,7 @@ curl -X PUT https://api.netbird.io/api/accounts/{accountId} \
|
||||
"auto_update_version": "0.51.2",
|
||||
"auto_update_always": false,
|
||||
"metrics_push_enabled": false,
|
||||
"peer_hostname_collision_rejected": false,
|
||||
"agent_network_only": false,
|
||||
"dashboard_features": {
|
||||
"agent_network": true
|
||||
@@ -788,6 +796,7 @@ let data = JSON.stringify({
|
||||
"auto_update_version": "0.51.2",
|
||||
"auto_update_always": false,
|
||||
"metrics_push_enabled": false,
|
||||
"peer_hostname_collision_rejected": false,
|
||||
"agent_network_only": false,
|
||||
"dashboard_features": {
|
||||
"agent_network": true
|
||||
@@ -868,6 +877,7 @@ payload = json.dumps({
|
||||
"auto_update_version": "0.51.2",
|
||||
"auto_update_always": false,
|
||||
"metrics_push_enabled": false,
|
||||
"peer_hostname_collision_rejected": false,
|
||||
"agent_network_only": false,
|
||||
"dashboard_features": {
|
||||
"agent_network": true
|
||||
@@ -948,6 +958,7 @@ func main() {
|
||||
"auto_update_version": "0.51.2",
|
||||
"auto_update_always": false,
|
||||
"metrics_push_enabled": false,
|
||||
"peer_hostname_collision_rejected": false,
|
||||
"agent_network_only": false,
|
||||
"dashboard_features": {
|
||||
"agent_network": true
|
||||
@@ -1047,6 +1058,7 @@ request.body = JSON.dump({
|
||||
"auto_update_version": "0.51.2",
|
||||
"auto_update_always": false,
|
||||
"metrics_push_enabled": false,
|
||||
"peer_hostname_collision_rejected": false,
|
||||
"agent_network_only": false,
|
||||
"dashboard_features": {
|
||||
"agent_network": true
|
||||
@@ -1109,6 +1121,7 @@ RequestBody body = RequestBody.create(mediaType, '{
|
||||
"auto_update_version": "0.51.2",
|
||||
"auto_update_always": false,
|
||||
"metrics_push_enabled": false,
|
||||
"peer_hostname_collision_rejected": false,
|
||||
"agent_network_only": false,
|
||||
"dashboard_features": {
|
||||
"agent_network": true
|
||||
@@ -1187,6 +1200,7 @@ curl_setopt_array($curl, array(
|
||||
"auto_update_version": "0.51.2",
|
||||
"auto_update_always": false,
|
||||
"metrics_push_enabled": false,
|
||||
"peer_hostname_collision_rejected": false,
|
||||
"agent_network_only": false,
|
||||
"dashboard_features": {
|
||||
"agent_network": true
|
||||
@@ -1260,6 +1274,7 @@ echo $response;
|
||||
"auto_update_version": "0.51.2",
|
||||
"auto_update_always": false,
|
||||
"metrics_push_enabled": false,
|
||||
"peer_hostname_collision_rejected": false,
|
||||
"agent_network_only": false,
|
||||
"dashboard_features": {
|
||||
"agent_network": true
|
||||
@@ -1317,6 +1332,7 @@ echo $response;
|
||||
"auto_update_version": "string",
|
||||
"auto_update_always": "boolean",
|
||||
"metrics_push_enabled": "boolean",
|
||||
"peer_hostname_collision_rejected": "boolean",
|
||||
"agent_network_only": "boolean",
|
||||
"dashboard_features": {
|
||||
"agent_network": "boolean"
|
||||
|
||||
@@ -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>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -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>
|
||||
|
||||
@@ -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",
|
||||
|
||||
@@ -214,6 +214,11 @@ echo $response;
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -269,6 +274,11 @@ echo $response;
|
||||
"windows_path": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -520,6 +530,23 @@ echo $response;
|
||||
</Properties>
|
||||
</details>
|
||||
|
||||
</Property>
|
||||
<Property name="certificate_check" type="object" required={false}>
|
||||
|
||||
<details className="custom-details" open>
|
||||
<summary>Posture check for a certificate held by the peer that chains to one of the given CA certificates. Not supported on mobile devices (iOS and Android), which always fail this check and are denied access</summary>
|
||||
<Properties>
|
||||
|
||||
<Properties><Property name="ca_certificates" type="string[]" required={true}>
|
||||
|
||||
PEM encoded CA certificates the peer's certificate must chain to
|
||||
|
||||
</Property>
|
||||
</Properties>
|
||||
|
||||
</Properties>
|
||||
</details>
|
||||
|
||||
</Property>
|
||||
</Properties>
|
||||
|
||||
@@ -590,6 +617,11 @@ curl -X POST https://api.netbird.io/api/posture-checks \
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}'
|
||||
@@ -648,6 +680,11 @@ let data = JSON.stringify({
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
});
|
||||
@@ -728,6 +765,11 @@ payload = json.dumps({
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
})
|
||||
@@ -808,6 +850,11 @@ func main() {
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}`)
|
||||
@@ -907,6 +954,11 @@ request.body = JSON.dump({
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
})
|
||||
@@ -969,6 +1021,11 @@ RequestBody body = RequestBody.create(mediaType, '{
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}');
|
||||
@@ -1047,6 +1104,11 @@ curl_setopt_array($curl, array(
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}',
|
||||
@@ -1120,6 +1182,11 @@ echo $response;
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1173,6 +1240,11 @@ echo $response;
|
||||
"windows_path": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1405,6 +1477,11 @@ echo $response;
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1458,6 +1535,11 @@ echo $response;
|
||||
"windows_path": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1716,6 +1798,23 @@ echo $response;
|
||||
</Properties>
|
||||
</details>
|
||||
|
||||
</Property>
|
||||
<Property name="certificate_check" type="object" required={false}>
|
||||
|
||||
<details className="custom-details" open>
|
||||
<summary>Posture check for a certificate held by the peer that chains to one of the given CA certificates. Not supported on mobile devices (iOS and Android), which always fail this check and are denied access</summary>
|
||||
<Properties>
|
||||
|
||||
<Properties><Property name="ca_certificates" type="string[]" required={true}>
|
||||
|
||||
PEM encoded CA certificates the peer's certificate must chain to
|
||||
|
||||
</Property>
|
||||
</Properties>
|
||||
|
||||
</Properties>
|
||||
</details>
|
||||
|
||||
</Property>
|
||||
</Properties>
|
||||
|
||||
@@ -1786,6 +1885,11 @@ curl -X PUT https://api.netbird.io/api/posture-checks/{postureCheckId} \
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}'
|
||||
@@ -1844,6 +1948,11 @@ let data = JSON.stringify({
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
});
|
||||
@@ -1924,6 +2033,11 @@ payload = json.dumps({
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
})
|
||||
@@ -2004,6 +2118,11 @@ func main() {
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}`)
|
||||
@@ -2103,6 +2222,11 @@ request.body = JSON.dump({
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
})
|
||||
@@ -2165,6 +2289,11 @@ RequestBody body = RequestBody.create(mediaType, '{
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}');
|
||||
@@ -2243,6 +2372,11 @@ curl_setopt_array($curl, array(
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}',
|
||||
@@ -2316,6 +2450,11 @@ echo $response;
|
||||
"windows_path": "C:
rogramData
etBird\netbird.exe"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2369,6 +2508,11 @@ echo $response;
|
||||
"windows_path": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"certificate_check": {
|
||||
"ca_certificates": [
|
||||
"string"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -537,6 +537,7 @@ echo $response;
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -635,6 +636,7 @@ echo $response;
|
||||
"target_id": "string",
|
||||
"target_type": "string",
|
||||
"path": "string",
|
||||
"access_action": "string",
|
||||
"protocol": "string",
|
||||
"host": "string",
|
||||
"port": "integer",
|
||||
@@ -772,6 +774,11 @@ echo $response;
|
||||
|
||||
URL path prefix for this target (HTTP only)
|
||||
|
||||
</Property>
|
||||
<Property name="access_action" type="string" required={false} enumList={["inherit","bypass","block"]}>
|
||||
|
||||
Access action applied after this target's HTTP path prefix is selected. "inherit" uses the service authentication configuration, "bypass" skips service authentication, and "block" denies access. HTTP services only.
|
||||
|
||||
</Property>
|
||||
<Property name="protocol" type="string" required={true} enumList={["http","https","tcp","udp"]}>
|
||||
|
||||
@@ -1056,6 +1063,7 @@ curl -X POST https://api.netbird.io/api/reverse-proxies/services \
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -1145,6 +1153,7 @@ let data = JSON.stringify({
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -1256,6 +1265,7 @@ payload = json.dumps({
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -1367,6 +1377,7 @@ func main() {
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -1497,6 +1508,7 @@ request.body = JSON.dump({
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -1590,6 +1602,7 @@ RequestBody body = RequestBody.create(mediaType, '{
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -1699,6 +1712,7 @@ curl_setopt_array($curl, array(
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -1805,6 +1819,7 @@ echo $response;
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -1901,6 +1916,7 @@ echo $response;
|
||||
"target_id": "string",
|
||||
"target_type": "string",
|
||||
"path": "string",
|
||||
"access_action": "string",
|
||||
"protocol": "string",
|
||||
"host": "string",
|
||||
"port": "integer",
|
||||
@@ -2169,6 +2185,7 @@ echo $response;
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -2265,6 +2282,7 @@ echo $response;
|
||||
"target_id": "string",
|
||||
"target_type": "string",
|
||||
"path": "string",
|
||||
"access_action": "string",
|
||||
"protocol": "string",
|
||||
"host": "string",
|
||||
"port": "integer",
|
||||
@@ -2409,6 +2427,11 @@ echo $response;
|
||||
|
||||
URL path prefix for this target (HTTP only)
|
||||
|
||||
</Property>
|
||||
<Property name="access_action" type="string" required={false} enumList={["inherit","bypass","block"]}>
|
||||
|
||||
Access action applied after this target's HTTP path prefix is selected. "inherit" uses the service authentication configuration, "bypass" skips service authentication, and "block" denies access. HTTP services only.
|
||||
|
||||
</Property>
|
||||
<Property name="protocol" type="string" required={true} enumList={["http","https","tcp","udp"]}>
|
||||
|
||||
@@ -2693,6 +2716,7 @@ curl -X PUT https://api.netbird.io/api/reverse-proxies/services/{serviceId} \
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -2782,6 +2806,7 @@ let data = JSON.stringify({
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -2893,6 +2918,7 @@ payload = json.dumps({
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -3004,6 +3030,7 @@ func main() {
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -3134,6 +3161,7 @@ request.body = JSON.dump({
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -3227,6 +3255,7 @@ RequestBody body = RequestBody.create(mediaType, '{
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -3336,6 +3365,7 @@ curl_setopt_array($curl, array(
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -3442,6 +3472,7 @@ echo $response;
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -3538,6 +3569,7 @@ echo $response;
|
||||
"target_id": "string",
|
||||
"target_type": "string",
|
||||
"path": "string",
|
||||
"access_action": "string",
|
||||
"protocol": "string",
|
||||
"host": "string",
|
||||
"port": "integer",
|
||||
@@ -4210,6 +4242,7 @@ echo $response;
|
||||
"target_id": "cs8i4ug6lnn4g9hqv7mg",
|
||||
"target_type": "subnet",
|
||||
"path": "/",
|
||||
"access_action": "inherit",
|
||||
"protocol": "http",
|
||||
"host": "10.10.0.1",
|
||||
"port": 8080,
|
||||
@@ -4306,6 +4339,7 @@ echo $response;
|
||||
"target_id": "string",
|
||||
"target_type": "string",
|
||||
"path": "string",
|
||||
"access_action": "string",
|
||||
"protocol": "string",
|
||||
"host": "string",
|
||||
"port": "integer",
|
||||
|
||||
Reference in New Issue
Block a user