sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-10-09 15:19:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update API pages with v0.81.0-canary.pr-7890.1

Browse Source
This commit is contained in:
netbirddev
2026-10-06 21:35:00 +00:00
parent 698b4c48ab
commit fd7f5c0ddb
2 changed files with 2624 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pages/ipa/resources/ingress-ports.mdx
+2480
View File
File diff suppressed because it is too large Load Diff
src/pages/ipa/resources/posture-checks.mdx
+144
View File
@@ -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"
]
}
}
}