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

Update API pages with v0.23.7

Browse Source
This commit is contained in:
netbirddev
2023-10-04 13:12:35 +00:00
parent fa96652faf
commit ecbbadfe75
1 changed files with 84 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
src/pages/ipa/resources/routes.mdx
View File

@@ -169,6 +169,9 @@ echo $response;
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -187,6 +190,9 @@ echo $response;
"network_id": "string",
"enabled": "boolean",
"peer": "string",
"peer_groups": [
"string"
],
"network": "string",
"metric": "integer",
"masquerade": "boolean",
@@ -242,11 +248,18 @@ echo $response;
Route status
</Property>
<Property name="peer" type="string" required={true}
<Property name="peer" type="string" required={false}
>
Peer Identifier associated with route
Peer Identifier associated with route. This property can not be set together with `peer_groups`
</Property>
<Property name="peer_groups" type="string[]" required={false}
>
Peers Group Identifier associated with route. This property can not be set together with `peer`
</Property>
<Property name="network" type="string" required={true}
@@ -295,6 +308,9 @@ curl -X POST https://api.netbird.io/api/routes \
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -311,6 +327,9 @@ let data = JSON.stringify({
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -349,6 +368,9 @@ payload = json.dumps({
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -387,6 +409,9 @@ func main() {
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -443,6 +468,9 @@ request.body = JSON.dump({
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -463,6 +491,9 @@ RequestBody body = RequestBody.create(mediaType, '{
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -499,6 +530,9 @@ curl_setopt_array($curl, array(
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -532,6 +566,9 @@ echo $response;
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -548,6 +585,9 @@ echo $response;
"network_id": "string",
"enabled": "boolean",
"peer": "string",
"peer_groups": [
"string"
],
"network": "string",
"metric": "integer",
"masquerade": "boolean",
@@ -742,6 +782,9 @@ echo $response;
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -758,6 +801,9 @@ echo $response;
"network_id": "string",
"enabled": "boolean",
"peer": "string",
"peer_groups": [
"string"
],
"network": "string",
"metric": "integer",
"masquerade": "boolean",
@@ -820,11 +866,18 @@ echo $response;
Route status
</Property>
<Property name="peer" type="string" required={true}
<Property name="peer" type="string" required={false}
>
Peer Identifier associated with route
Peer Identifier associated with route. This property can not be set together with `peer_groups`
</Property>
<Property name="peer_groups" type="string[]" required={false}
>
Peers Group Identifier associated with route. This property can not be set together with `peer`
</Property>
<Property name="network" type="string" required={true}
@@ -873,6 +926,9 @@ curl -X PUT https://api.netbird.io/api/routes/{routeId} \
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -889,6 +945,9 @@ let data = JSON.stringify({
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -927,6 +986,9 @@ payload = json.dumps({
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -965,6 +1027,9 @@ func main() {
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -1021,6 +1086,9 @@ request.body = JSON.dump({
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -1041,6 +1109,9 @@ RequestBody body = RequestBody.create(mediaType, '{
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -1077,6 +1148,9 @@ curl_setopt_array($curl, array(
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -1110,6 +1184,9 @@ echo $response;
"network_id": "Route 1",
"enabled": true,
"peer": "chacbco6lnnbn6cg5s91",
"peer_groups": [
"chacbco6lnnbn6cg5s91"
],
"network": "10.64.0.0/24",
"metric": 9999,
"masquerade": true,
@@ -1126,6 +1203,9 @@ echo $response;
"network_id": "string",
"enabled": "boolean",
"peer": "string",
"peer_groups": [
"string"
],
"network": "string",
"metric": "integer",
"masquerade": "boolean",