From b7a15c65b259f581b5b492e525d53d026ef1d013 Mon Sep 17 00:00:00 2001 From: netbirddev Date: Fri, 4 Oct 2024 17:50:13 +0000 Subject: [PATCH] Update API pages with v0.30.0 --- src/pages/ipa/resources/policies.mdx | 180 ++++++++++++++++++++- src/pages/ipa/resources/posture-checks.mdx | 144 +++++++---------- src/pages/ipa/resources/routes.mdx | 120 +++++++++++--- 3 files changed, 330 insertions(+), 114 deletions(-) diff --git a/src/pages/ipa/resources/policies.mdx b/src/pages/ipa/resources/policies.mdx index c5d6b003..fbcdff65 100644 --- a/src/pages/ipa/resources/policies.mdx +++ b/src/pages/ipa/resources/policies.mdx @@ -181,6 +181,12 @@ echo $response; "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ { "id": "ch8i4ug6lnn4g9hqv7m0", @@ -224,6 +230,12 @@ echo $response; "ports": [ "string" ], + "port_ranges": [ + { + "start": "integer", + "end": "integer" + } + ], "sources": [ { "id": "string", @@ -330,7 +342,29 @@ echo $response; - Policy rule affected ports or it ranges list + Policy rule affected ports + + + + +
+ Policy rule affected ports ranges list + + + + + The starting port of the range + + + + + The ending port of the range + + + + + +
@@ -381,6 +415,12 @@ curl -X POST https://api.netbird.io/api/policies \ "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -414,6 +454,12 @@ let data = JSON.stringify({ "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -469,6 +515,12 @@ payload = json.dumps({ "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -524,6 +576,12 @@ func main() { "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -597,6 +655,12 @@ request.body = JSON.dump({ "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -634,6 +698,12 @@ RequestBody body = RequestBody.create(mediaType, '{ "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -687,6 +757,12 @@ curl_setopt_array($curl, array( "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -734,6 +810,12 @@ echo $response; "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ { "id": "ch8i4ug6lnn4g9hqv7m0", @@ -775,6 +857,12 @@ echo $response; "ports": [ "string" ], + "port_ranges": [ + { + "start": "integer", + "end": "integer" + } + ], "sources": [ { "id": "string", @@ -990,6 +1078,12 @@ echo $response; "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ { "id": "ch8i4ug6lnn4g9hqv7m0", @@ -1031,6 +1125,12 @@ echo $response; "ports": [ "string" ], + "port_ranges": [ + { + "start": "integer", + "end": "integer" + } + ], "sources": [ { "id": "string", @@ -1144,7 +1244,29 @@ echo $response; - Policy rule affected ports or it ranges list + Policy rule affected ports + + + + +
+ Policy rule affected ports ranges list + + + + + The starting port of the range + + + + + The ending port of the range + + + + + +
@@ -1195,6 +1317,12 @@ curl -X PUT https://api.netbird.io/api/policies/{policyId} \ "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -1228,6 +1356,12 @@ let data = JSON.stringify({ "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -1283,6 +1417,12 @@ payload = json.dumps({ "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -1338,6 +1478,12 @@ func main() { "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -1411,6 +1557,12 @@ request.body = JSON.dump({ "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -1448,6 +1600,12 @@ RequestBody body = RequestBody.create(mediaType, '{ "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -1501,6 +1659,12 @@ curl_setopt_array($curl, array( "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ "ch8i4ug6lnn4g9hqv797" ], @@ -1548,6 +1712,12 @@ echo $response; "ports": [ "80" ], + "port_ranges": [ + { + "start": 80, + "end": 320 + } + ], "sources": [ { "id": "ch8i4ug6lnn4g9hqv7m0", @@ -1589,6 +1759,12 @@ echo $response; "ports": [ "string" ], + "port_ranges": [ + { + "start": "integer", + "end": "integer" + } + ], "sources": [ { "id": "string", diff --git a/src/pages/ipa/resources/posture-checks.mdx b/src/pages/ipa/resources/posture-checks.mdx index bd02df77..6111e037 100644 --- a/src/pages/ipa/resources/posture-checks.mdx +++ b/src/pages/ipa/resources/posture-checks.mdx @@ -197,11 +197,9 @@ echo $response; }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -573,11 +571,9 @@ curl -X POST https://api.netbird.io/api/posture-checks \ }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -631,11 +627,9 @@ let data = JSON.stringify({ }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -711,11 +705,9 @@ payload = json.dumps({ }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -791,11 +783,9 @@ func main() { }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -889,11 +879,9 @@ request.body = JSON.dump({ }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -951,11 +939,9 @@ RequestBody body = RequestBody.create(mediaType, '{ }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -1029,11 +1015,9 @@ curl_setopt_array($curl, array( }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -1102,11 +1086,9 @@ echo $response; }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -1386,11 +1368,9 @@ echo $response; }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -1767,11 +1747,9 @@ curl -X PUT https://api.netbird.io/api/posture-checks/{postureCheckId} \ }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -1825,11 +1803,9 @@ let data = JSON.stringify({ }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -1905,11 +1881,9 @@ payload = json.dumps({ }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -1985,11 +1959,9 @@ func main() { }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -2083,11 +2055,9 @@ request.body = JSON.dump({ }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -2145,11 +2115,9 @@ RequestBody body = RequestBody.create(mediaType, '{ }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -2223,11 +2191,9 @@ curl_setopt_array($curl, array( }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, @@ -2296,11 +2262,9 @@ echo $response; }, "peer_network_range_check": { "ranges": [ - [ - "192.168.1.0/24", - "10.0.0.0/8", - "2001:db8:1234:1a00::/56" - ] + "192.168.1.0/24", + "10.0.0.0/8", + "2001:db8:1234:1a00::/56" ], "action": "allow" }, diff --git a/src/pages/ipa/resources/routes.mdx b/src/pages/ipa/resources/routes.mdx index 0119e0c0..a045389f 100644 --- a/src/pages/ipa/resources/routes.mdx +++ b/src/pages/ipa/resources/routes.mdx @@ -180,7 +180,10 @@ echo $response; "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] } ] ``` @@ -205,7 +208,10 @@ echo $response; "groups": [ "string" ], - "keep_route": "boolean" + "keep_route": "boolean", + "access_control_groups": [ + "string" + ] } ] ``` @@ -280,6 +286,11 @@ echo $response; Indicate if the route should be kept after a domain doesn't resolve that IP anymore + + + + Access control group identifier associated with route. + @@ -310,7 +321,10 @@ curl -X POST https://api.netbird.io/api/routes \ "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }' ``` @@ -333,7 +347,10 @@ let data = JSON.stringify({ "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }); let config = { method: 'post', @@ -378,7 +395,10 @@ payload = json.dumps({ "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }) headers = { 'Content-Type': 'application/json', @@ -423,7 +443,10 @@ func main() { "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }`) client := &http.Client { } @@ -486,7 +509,10 @@ request.body = JSON.dump({ "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }) response = https.request(request) puts response.read_body @@ -513,7 +539,10 @@ RequestBody body = RequestBody.create(mediaType, '{ "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }'); Request request = new Request.Builder() .url("https://api.netbird.io/api/routes") @@ -556,7 +585,10 @@ curl_setopt_array($curl, array( "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', @@ -595,7 +627,10 @@ echo $response; "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] } ``` ```json {{ title: 'Schema' }} @@ -618,7 +653,10 @@ echo $response; "groups": [ "string" ], - "keep_route": "boolean" + "keep_route": "boolean", + "access_control_groups": [ + "string" + ] } ``` @@ -815,7 +853,10 @@ echo $response; "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] } ``` ```json {{ title: 'Schema' }} @@ -838,7 +879,10 @@ echo $response; "groups": [ "string" ], - "keep_route": "boolean" + "keep_route": "boolean", + "access_control_groups": [ + "string" + ] } ``` @@ -920,6 +964,11 @@ echo $response; Indicate if the route should be kept after a domain doesn't resolve that IP anymore + + + + Access control group identifier associated with route. + @@ -950,7 +999,10 @@ curl -X PUT https://api.netbird.io/api/routes/{routeId} \ "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }' ``` @@ -973,7 +1025,10 @@ let data = JSON.stringify({ "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }); let config = { method: 'put', @@ -1018,7 +1073,10 @@ payload = json.dumps({ "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }) headers = { 'Content-Type': 'application/json', @@ -1063,7 +1121,10 @@ func main() { "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }`) client := &http.Client { } @@ -1126,7 +1187,10 @@ request.body = JSON.dump({ "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }) response = https.request(request) puts response.read_body @@ -1153,7 +1217,10 @@ RequestBody body = RequestBody.create(mediaType, '{ "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }'); Request request = new Request.Builder() .url("https://api.netbird.io/api/routes/{routeId}") @@ -1196,7 +1263,10 @@ curl_setopt_array($curl, array( "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] }', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', @@ -1235,7 +1305,10 @@ echo $response; "groups": [ "chacdk86lnnboviihd70" ], - "keep_route": true + "keep_route": true, + "access_control_groups": [ + "chacbco6lnnbn6cg5s91" + ] } ``` ```json {{ title: 'Schema' }} @@ -1258,7 +1331,10 @@ echo $response; "groups": [ "string" ], - "keep_route": "boolean" + "keep_route": "boolean", + "access_control_groups": [ + "string" + ] } ```