diff --git a/src/pages/ipa/resources/posture-checks.mdx b/src/pages/ipa/resources/posture-checks.mdx index e87f6962..bd02df77 100644 --- a/src/pages/ipa/resources/posture-checks.mdx +++ b/src/pages/ipa/resources/posture-checks.mdx @@ -204,6 +204,15 @@ echo $response; ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } } @@ -250,6 +259,15 @@ echo $response; "string" ], "action": "string" + }, + "process_check": { + "processes": [ + { + "linux_path": "string", + "mac_path": "string", + "windows_path": "string" + } + ] } } } @@ -462,6 +480,45 @@ echo $response; + + + +
+ Posture Check for binaries exist and are running in the peer’s system + + + + +
+ More Information + + + + + Path to the process executable file in a Linux operating system + + + + + Path to the process executable file in a Mac operating system + + + + + Path to the process executable file in a Windows operating system + + + + + +
+ +
+
+ +
+
+
@@ -523,6 +580,15 @@ curl -X POST https://api.netbird.io/api/posture-checks \ ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }' @@ -572,6 +638,15 @@ let data = JSON.stringify({ ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }); @@ -643,6 +718,15 @@ payload = json.dumps({ ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }) @@ -714,6 +798,15 @@ func main() { ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }`) @@ -803,6 +896,15 @@ request.body = JSON.dump({ ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }) @@ -856,6 +958,15 @@ RequestBody body = RequestBody.create(mediaType, '{ ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }'); @@ -925,6 +1036,15 @@ curl_setopt_array($curl, array( ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }', @@ -989,6 +1109,15 @@ echo $response; ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } } @@ -1033,6 +1162,15 @@ echo $response; "string" ], "action": "string" + }, + "process_check": { + "processes": [ + { + "linux_path": "string", + "mac_path": "string", + "windows_path": "string" + } + ] } } } @@ -1255,6 +1393,15 @@ echo $response; ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } } @@ -1299,6 +1446,15 @@ echo $response; "string" ], "action": "string" + }, + "process_check": { + "processes": [ + { + "linux_path": "string", + "mac_path": "string", + "windows_path": "string" + } + ] } } } @@ -1518,6 +1674,45 @@ echo $response; + + + +
+ Posture Check for binaries exist and are running in the peer’s system + + + + +
+ More Information + + + + + Path to the process executable file in a Linux operating system + + + + + Path to the process executable file in a Mac operating system + + + + + Path to the process executable file in a Windows operating system + + + + + +
+ +
+
+ +
+
+
@@ -1579,6 +1774,15 @@ curl -X PUT https://api.netbird.io/api/posture-checks/{postureCheckId} \ ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }' @@ -1628,6 +1832,15 @@ let data = JSON.stringify({ ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }); @@ -1699,6 +1912,15 @@ payload = json.dumps({ ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }) @@ -1770,6 +1992,15 @@ func main() { ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }`) @@ -1859,6 +2090,15 @@ request.body = JSON.dump({ ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }) @@ -1912,6 +2152,15 @@ RequestBody body = RequestBody.create(mediaType, '{ ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }'); @@ -1981,6 +2230,15 @@ curl_setopt_array($curl, array( ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } }', @@ -2045,6 +2303,15 @@ echo $response; ] ], "action": "allow" + }, + "process_check": { + "processes": [ + { + "linux_path": "/usr/local/bin/netbird", + "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird", + "windows_path": "C:
rogramData…etBird\netbird.exe" + } + ] } } } @@ -2089,6 +2356,15 @@ echo $response; "string" ], "action": "string" + }, + "process_check": { + "processes": [ + { + "linux_path": "string", + "mac_path": "string", + "windows_path": "string" + } + ] } } } diff --git a/src/pages/ipa/resources/routes.mdx b/src/pages/ipa/resources/routes.mdx index 13b62941..5ba02b16 100644 --- a/src/pages/ipa/resources/routes.mdx +++ b/src/pages/ipa/resources/routes.mdx @@ -172,11 +172,15 @@ echo $response; "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true } ] ``` @@ -193,11 +197,15 @@ echo $response; "string" ], "network": "string", + "domains": [ + "string" + ], "metric": "integer", "masquerade": "boolean", "groups": [ "string" - ] + ], + "keep_route": "boolean" } ] ``` @@ -243,9 +251,14 @@ echo $response; Peers Group Identifier associated with route. This property can not be set together with `peer` - + - Network range in CIDR format + Network range in CIDR format, Conflicts with domains + + + + + Domain list to be dynamically resolved. Conflicts with network @@ -262,6 +275,11 @@ echo $response; Group IDs containing routing peers + + + + Indicate if the route should be kept after a domain doesn't resolve that IP anymore + @@ -284,11 +302,15 @@ curl -X POST https://api.netbird.io/api/routes \ "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }' ``` @@ -303,11 +325,15 @@ let data = JSON.stringify({ "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }); let config = { method: 'post', @@ -344,11 +370,15 @@ payload = json.dumps({ "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }) headers = { 'Content-Type': 'application/json', @@ -385,11 +415,15 @@ func main() { "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }`) client := &http.Client { } @@ -444,11 +478,15 @@ request.body = JSON.dump({ "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }) response = https.request(request) puts response.read_body @@ -467,11 +505,15 @@ RequestBody body = RequestBody.create(mediaType, '{ "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }'); Request request = new Request.Builder() .url("https://api.netbird.io/api/routes") @@ -506,11 +548,15 @@ curl_setopt_array($curl, array( "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', @@ -541,11 +587,15 @@ echo $response; "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true } ``` ```json {{ title: 'Schema' }} @@ -560,11 +610,15 @@ echo $response; "string" ], "network": "string", + "domains": [ + "string" + ], "metric": "integer", "masquerade": "boolean", "groups": [ "string" - ] + ], + "keep_route": "boolean" } ``` @@ -753,11 +807,15 @@ echo $response; "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true } ``` ```json {{ title: 'Schema' }} @@ -772,11 +830,15 @@ echo $response; "string" ], "network": "string", + "domains": [ + "string" + ], "metric": "integer", "masquerade": "boolean", "groups": [ "string" - ] + ], + "keep_route": "boolean" } ``` @@ -829,9 +891,14 @@ echo $response; Peers Group Identifier associated with route. This property can not be set together with `peer` - + - Network range in CIDR format + Network range in CIDR format, Conflicts with domains + + + + + Domain list to be dynamically resolved. Conflicts with network @@ -848,6 +915,11 @@ echo $response; Group IDs containing routing peers + + + + Indicate if the route should be kept after a domain doesn't resolve that IP anymore + @@ -870,11 +942,15 @@ curl -X PUT https://api.netbird.io/api/routes/{routeId} \ "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }' ``` @@ -889,11 +965,15 @@ let data = JSON.stringify({ "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }); let config = { method: 'put', @@ -930,11 +1010,15 @@ payload = json.dumps({ "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }) headers = { 'Content-Type': 'application/json', @@ -971,11 +1055,15 @@ func main() { "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }`) client := &http.Client { } @@ -1030,11 +1118,15 @@ request.body = JSON.dump({ "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }) response = https.request(request) puts response.read_body @@ -1053,11 +1145,15 @@ RequestBody body = RequestBody.create(mediaType, '{ "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }'); Request request = new Request.Builder() .url("https://api.netbird.io/api/routes/{routeId}") @@ -1092,11 +1188,15 @@ curl_setopt_array($curl, array( "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true }', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', @@ -1127,11 +1227,15 @@ echo $response; "chacbco6lnnbn6cg5s91" ], "network": "10.64.0.0/24", + "domains": [ + "example.com" + ], "metric": 9999, "masquerade": true, "groups": [ "chacdk86lnnboviihd70" - ] + ], + "keep_route": true } ``` ```json {{ title: 'Schema' }} @@ -1146,11 +1250,15 @@ echo $response; "string" ], "network": "string", + "domains": [ + "string" + ], "metric": "integer", "masquerade": "boolean", "groups": [ "string" - ] + ], + "keep_route": "boolean" } ```