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

Update API pages with v0.75.0

Browse Source
This commit is contained in:
netbirddev
2026-07-23 16:27:29 +00:00
parent 24d6bf97d9
commit 2dd6788def
3 changed files with 130 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pages/ipa/resources/agent-network.mdx
+46 -14
View File
@@ -3673,6 +3673,7 @@ echo $response;
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false,
"metadata_disabled": false,
"created_at": "2026-04-26T10:30:00Z",
"updated_at": "2026-04-26T10:30:00Z"
}
@@ -3704,6 +3705,7 @@ echo $response;
"identity_header_groups": "string",
"enabled": "boolean",
"skip_tls_verification": "boolean",
"metadata_disabled": "boolean",
"created_at": "string",
"updated_at": "string"
}
@@ -3805,6 +3807,11 @@ echo $response;
Skip upstream TLS certificate verification when the proxy dials this provider's URL. For self-hosted / internal gateways behind a private or self-signed certificate. Defaults to false. When omitted on update, the stored value is left unchanged.
</Property>
<Property name="metadata_disabled" type="boolean" required={false}>
Disable identity metadata injection (the caller's user + authorizing group) for this provider. Defaults to false (metadata is injected). When omitted on update, the stored value is left unchanged.
</Property>
</Properties>
@@ -3837,7 +3844,8 @@ curl -X POST https://api.netbird.io/api/agent-network/providers \
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
}'
```
@@ -3862,7 +3870,8 @@ let data = JSON.stringify({
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
});
let config = {
method: 'post',
@@ -3909,7 +3918,8 @@ payload = json.dumps({
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
})
headers = {
'Content-Type': 'application/json',
@@ -3956,7 +3966,8 @@ func main() {
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
}`)
client := &http.Client {
}
@@ -4022,7 +4033,8 @@ request.body = JSON.dump({
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
})
response = https.request(request)
puts response.read_body
@@ -4051,7 +4063,8 @@ RequestBody body = RequestBody.create(mediaType, '{
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/agent-network/providers")
@@ -4096,7 +4109,8 @@ curl_setopt_array($curl, array(
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
@@ -4135,6 +4149,7 @@ echo $response;
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false,
"metadata_disabled": false,
"created_at": "2026-04-26T10:30:00Z",
"updated_at": "2026-04-26T10:30:00Z"
}
@@ -4164,6 +4179,7 @@ echo $response;
"identity_header_groups": "string",
"enabled": "boolean",
"skip_tls_verification": "boolean",
"metadata_disabled": "boolean",
"created_at": "string",
"updated_at": "string"
}
@@ -4363,6 +4379,7 @@ echo $response;
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false,
"metadata_disabled": false,
"created_at": "2026-04-26T10:30:00Z",
"updated_at": "2026-04-26T10:30:00Z"
}
@@ -4392,6 +4409,7 @@ echo $response;
"identity_header_groups": "string",
"enabled": "boolean",
"skip_tls_verification": "boolean",
"metadata_disabled": "boolean",
"created_at": "string",
"updated_at": "string"
}
@@ -4500,6 +4518,11 @@ echo $response;
Skip upstream TLS certificate verification when the proxy dials this provider's URL. For self-hosted / internal gateways behind a private or self-signed certificate. Defaults to false. When omitted on update, the stored value is left unchanged.
</Property>
<Property name="metadata_disabled" type="boolean" required={false}>
Disable identity metadata injection (the caller's user + authorizing group) for this provider. Defaults to false (metadata is injected). When omitted on update, the stored value is left unchanged.
</Property>
</Properties>
@@ -4532,7 +4555,8 @@ curl -X PUT https://api.netbird.io/api/agent-network/providers/{providerId} \
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
}'
```
@@ -4557,7 +4581,8 @@ let data = JSON.stringify({
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
});
let config = {
method: 'put',
@@ -4604,7 +4629,8 @@ payload = json.dumps({
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
})
headers = {
'Content-Type': 'application/json',
@@ -4651,7 +4677,8 @@ func main() {
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
}`)
client := &http.Client {
}
@@ -4717,7 +4744,8 @@ request.body = JSON.dump({
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
})
response = https.request(request)
puts response.read_body
@@ -4746,7 +4774,8 @@ RequestBody body = RequestBody.create(mediaType, '{
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/agent-network/providers/{providerId}")
@@ -4791,7 +4820,8 @@ curl_setopt_array($curl, array(
"identity_header_user_id": "x-bf-dim-netbird_user_id",
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false
"skip_tls_verification": false,
"metadata_disabled": false
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
@@ -4830,6 +4860,7 @@ echo $response;
"identity_header_groups": "x-bf-dim-netbird_groups",
"enabled": true,
"skip_tls_verification": false,
"metadata_disabled": false,
"created_at": "2026-04-26T10:30:00Z",
"updated_at": "2026-04-26T10:30:00Z"
}
@@ -4859,6 +4890,7 @@ echo $response;
"identity_header_groups": "string",
"enabled": "boolean",
"skip_tls_verification": "boolean",
"metadata_disabled": "boolean",
"created_at": "string",
"updated_at": "string"
}