sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-20 17:36:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update API pages with v0.36.0

Browse Source
This commit is contained in:
netbirddev
2025-01-16 18:38:07 +00:00
parent 5f68230137
commit 3ed36b6a0d
2 changed files with 312 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
src/pages/ipa/resources/networks.mdx
View File

@@ -1267,7 +1267,8 @@ echo $response;
],
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1"
"address": "1.1.1.1",
"enabled": true
}
]
```
@@ -1287,7 +1288,8 @@ echo $response;
],
"name": "string",
"description": "string",
"address": "string"
"address": "string",
"enabled": "boolean"
}
]
```
@@ -1330,6 +1332,11 @@ echo $response;
Network resource address (either a direct host like 1.1.1.1 or 1.1.1.1/32, or a subnet like 192.168.178.0/24, or domains like example.com and *.example.com)
</Property>
<Property name="enabled" type="boolean" required={true}>
Network resource status
</Property>
<Property name="groups" type="string[]" required={true}>
@@ -1352,6 +1359,7 @@ curl -X POST https://api.netbird.io/api/networks/{networkId}/resources \
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -1364,6 +1372,7 @@ let data = JSON.stringify({
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -1398,6 +1407,7 @@ payload = json.dumps({
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -1432,6 +1442,7 @@ func main() {
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -1484,6 +1495,7 @@ request.body = JSON.dump({
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -1500,6 +1512,7 @@ RequestBody body = RequestBody.create(mediaType, '{
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -1532,6 +1545,7 @@ curl_setopt_array($curl, array(
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -1568,7 +1582,8 @@ echo $response;
],
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1"
"address": "1.1.1.1",
"enabled": true
}
```
```json {{ title: 'Schema' }}
@@ -1586,7 +1601,8 @@ echo $response;
],
"name": "string",
"description": "string",
"address": "string"
"address": "string",
"enabled": "boolean"
}
```
</CodeGroup>
@@ -1782,7 +1798,8 @@ echo $response;
],
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1"
"address": "1.1.1.1",
"enabled": true
}
```
```json {{ title: 'Schema' }}
@@ -1800,7 +1817,8 @@ echo $response;
],
"name": "string",
"description": "string",
"address": "string"
"address": "string",
"enabled": "boolean"
}
```
</CodeGroup>
@@ -1846,6 +1864,11 @@ echo $response;
Network resource address (either a direct host like 1.1.1.1 or 1.1.1.1/32, or a subnet like 192.168.178.0/24, or domains like example.com and *.example.com)
</Property>
<Property name="enabled" type="boolean" required={true}>
Network resource status
</Property>
<Property name="groups" type="string[]" required={true}>
@@ -1868,6 +1891,7 @@ curl -X PUT https://api.netbird.io/api/networks/{networkId}/resources/{resourceI
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -1880,6 +1904,7 @@ let data = JSON.stringify({
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -1914,6 +1939,7 @@ payload = json.dumps({
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -1948,6 +1974,7 @@ func main() {
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -2000,6 +2027,7 @@ request.body = JSON.dump({
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -2016,6 +2044,7 @@ RequestBody body = RequestBody.create(mediaType, '{
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -2048,6 +2077,7 @@ curl_setopt_array($curl, array(
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1",
"enabled": true,
"groups": [
"chacdk86lnnboviihd70"
]
@@ -2084,7 +2114,8 @@ echo $response;
],
"name": "Remote Resource 1",
"description": "A remote resource inside network 1",
"address": "1.1.1.1"
"address": "1.1.1.1",
"enabled": true
}
```
```json {{ title: 'Schema' }}
@@ -2102,7 +2133,8 @@ echo $response;
],
"name": "string",
"description": "string",
"address": "string"
"address": "string",
"enabled": "boolean"
}
```
</CodeGroup>
@@ -2456,7 +2488,8 @@ echo $response;
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}
]
```
@@ -2469,7 +2502,8 @@ echo $response;
"string"
],
"metric": "integer",
"masquerade": "boolean"
"masquerade": "boolean",
"enabled": "boolean"
}
]
```
@@ -2517,6 +2551,11 @@ echo $response;
Indicate if peer should masquerade traffic to this route's prefix
</Property>
<Property name="enabled" type="boolean" required={true}>
Network router status
</Property>
</Properties>
@@ -2536,7 +2575,8 @@ curl -X POST https://api.netbird.io/api/networks/{networkId}/routers \
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}'
```
@@ -2548,7 +2588,8 @@ let data = JSON.stringify({
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
});
let config = {
method: 'post',
@@ -2582,7 +2623,8 @@ payload = json.dumps({
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
})
headers = {
'Content-Type': 'application/json',
@@ -2616,7 +2658,8 @@ func main() {
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}`)
client := &http.Client {
}
@@ -2668,7 +2711,8 @@ request.body = JSON.dump({
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
})
response = https.request(request)
puts response.read_body
@@ -2684,7 +2728,8 @@ RequestBody body = RequestBody.create(mediaType, '{
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/networks/{networkId}/routers")
@@ -2716,7 +2761,8 @@ curl_setopt_array($curl, array(
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
@@ -2743,7 +2789,8 @@ echo $response;
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}
```
```json {{ title: 'Schema' }}
@@ -2754,7 +2801,8 @@ echo $response;
"string"
],
"metric": "integer",
"masquerade": "boolean"
"masquerade": "boolean",
"enabled": "boolean"
}
```
</CodeGroup>
@@ -2943,7 +2991,8 @@ echo $response;
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}
```
```json {{ title: 'Schema' }}
@@ -2954,7 +3003,8 @@ echo $response;
"string"
],
"metric": "integer",
"masquerade": "boolean"
"masquerade": "boolean",
"enabled": "boolean"
}
```
</CodeGroup>
@@ -3005,6 +3055,11 @@ echo $response;
Indicate if peer should masquerade traffic to this route's prefix
</Property>
<Property name="enabled" type="boolean" required={true}>
Network router status
</Property>
</Properties>
@@ -3024,7 +3079,8 @@ curl -X PUT https://api.netbird.io/api/networks/{networkId}/routers/{routerId} \
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}'
```
@@ -3036,7 +3092,8 @@ let data = JSON.stringify({
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
});
let config = {
method: 'put',
@@ -3070,7 +3127,8 @@ payload = json.dumps({
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
})
headers = {
'Content-Type': 'application/json',
@@ -3104,7 +3162,8 @@ func main() {
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}`)
client := &http.Client {
}
@@ -3156,7 +3215,8 @@ request.body = JSON.dump({
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
})
response = https.request(request)
puts response.read_body
@@ -3172,7 +3232,8 @@ RequestBody body = RequestBody.create(mediaType, '{
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/networks/{networkId}/routers/{routerId}")
@@ -3204,7 +3265,8 @@ curl_setopt_array($curl, array(
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
@@ -3231,7 +3293,8 @@ echo $response;
"chacbco6lnnbn6cg5s91"
],
"metric": 9999,
"masquerade": true
"masquerade": true,
"enabled": true
}
```
```json {{ title: 'Schema' }}
@@ -3242,7 +3305,8 @@ echo $response;
"string"
],
"metric": "integer",
"masquerade": "boolean"
"masquerade": "boolean",
"enabled": "boolean"
}
```
</CodeGroup>

236
src/pages/ipa/resources/policies.mdx
View File

@@ -382,15 +382,59 @@ echo $response;
Policy rule ID
</Property>
<Property name="sources" type="string[]" required={true}>
<Property name="sources" type="string[]" required={false}>
Policy rule source group IDs
</Property>
<Property name="destinations" type="string[]" required={true}>
<Property name="sourceResource" type="object" required={false}>
<details class="custom-details" open>
<summary>More Information</summary>
<Properties>
<Properties><Property name="id" type="string" required={true}>
ID of the resource
</Property>
<Property name="type" type="string" required={true} enumList={["host","subnet","domain"]}>
Network resource type based of the address
</Property>
</Properties>
</Properties>
</details>
</Property>
<Property name="destinations" type="string[]" required={false}>
Policy rule destination group IDs
</Property>
<Property name="destinationResource" type="object" required={false}>
<details class="custom-details" open>
<summary>More Information</summary>
<Properties>
<Properties><Property name="id" type="string" required={true}>
ID of the resource
</Property>
<Property name="type" type="string" required={true} enumList={["host","subnet","domain"]}>
Network resource type based of the address
</Property>
</Properties>
</Properties>
</details>
</Property>
</Properties>
@@ -438,9 +482,17 @@ curl -X POST https://api.netbird.io/api/policies \
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}'
@@ -476,9 +528,17 @@ let data = JSON.stringify({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
});
@@ -536,9 +596,17 @@ payload = json.dumps({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
})
@@ -596,9 +664,17 @@ func main() {
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}`)
@@ -674,9 +750,17 @@ request.body = JSON.dump({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
})
@@ -716,9 +800,17 @@ RequestBody body = RequestBody.create(mediaType, '{
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}');
@@ -774,9 +866,17 @@ curl_setopt_array($curl, array(
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}',
@@ -1312,15 +1412,59 @@ echo $response;
Policy rule ID
</Property>
<Property name="sources" type="string[]" required={true}>
<Property name="sources" type="string[]" required={false}>
Policy rule source group IDs
</Property>
<Property name="destinations" type="string[]" required={true}>
<Property name="sourceResource" type="object" required={false}>
<details class="custom-details" open>
<summary>More Information</summary>
<Properties>
<Properties><Property name="id" type="string" required={true}>
ID of the resource
</Property>
<Property name="type" type="string" required={true} enumList={["host","subnet","domain"]}>
Network resource type based of the address
</Property>
</Properties>
</Properties>
</details>
</Property>
<Property name="destinations" type="string[]" required={false}>
Policy rule destination group IDs
</Property>
<Property name="destinationResource" type="object" required={false}>
<details class="custom-details" open>
<summary>More Information</summary>
<Properties>
<Properties><Property name="id" type="string" required={true}>
ID of the resource
</Property>
<Property name="type" type="string" required={true} enumList={["host","subnet","domain"]}>
Network resource type based of the address
</Property>
</Properties>
</Properties>
</details>
</Property>
</Properties>
@@ -1368,9 +1512,17 @@ curl -X PUT https://api.netbird.io/api/policies/{policyId} \
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}'
@@ -1406,9 +1558,17 @@ let data = JSON.stringify({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
});
@@ -1466,9 +1626,17 @@ payload = json.dumps({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
})
@@ -1526,9 +1694,17 @@ func main() {
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}`)
@@ -1604,9 +1780,17 @@ request.body = JSON.dump({
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
})
@@ -1646,9 +1830,17 @@ RequestBody body = RequestBody.create(mediaType, '{
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}');
@@ -1704,9 +1896,17 @@ curl_setopt_array($curl, array(
"sources": [
"ch8i4ug6lnn4g9hqv797"
],
"sourceResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
},
"destinations": [
"ch8i4ug6lnn4g9h7v7m0"
]
],
"destinationResource": {
"id": "chacdk86lnnboviihd7g",
"type": "host"
}
}
]
}',