sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-08-27 02:01:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update API pages with v0.71.0

Browse Source
This commit is contained in:
netbirddev
2026-05-14 16:39:03 +00:00
parent 8b1fe13cac
commit f3ee9f9f83
35 changed files with 1147 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

149
src/pages/ipa/resources/accounts.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -177,7 +178,12 @@ echo $response;
],
"routing_peer_dns_resolution_enabled": true,
"dns_domain": "my-organization.org",
"network_range": "100.64.0.0/16",
"network_range": {
"description": "Allows to define a custom network range for the account in CIDR format",
"type": "string",
"format": "cidr"
},
"network_range_v6": "fd00:1234:5678::/64",
"peer_expose_enabled": false,
"peer_expose_groups": [
"ch8i4ug6lnn4g9hqv7m0"
@@ -195,7 +201,11 @@ echo $response;
"auto_update_version": "0.51.2",
"auto_update_always": false,
"embedded_idp_enabled": false,
"local_auth_disabled": false
"local_auth_disabled": false,
"local_mfa_enabled": false,
"ipv6_enabled_groups": [
"ch8i4ug6lnn4g9hqv7m0"
]
},
"domain": "netbird.io",
"domain_category": "private",
@@ -227,6 +237,7 @@ echo $response;
"routing_peer_dns_resolution_enabled": "boolean",
"dns_domain": "string",
"network_range": "string",
"network_range_v6": "string",
"peer_expose_enabled": "boolean",
"peer_expose_groups": [
"string"
@@ -244,7 +255,11 @@ echo $response;
"auto_update_version": "string",
"auto_update_always": "boolean",
"embedded_idp_enabled": "boolean",
"local_auth_disabled": "boolean"
"local_auth_disabled": "boolean",
"local_mfa_enabled": "boolean",
"ipv6_enabled_groups": [
"string"
]
},
"domain": "string",
"domain_category": "string",
@@ -347,6 +362,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -511,6 +527,11 @@ echo $response;
Allows to define a custom network range for the account in CIDR format
</Property>
<Property name="network_range_v6" type="string" required={false}>
Allows to define a custom IPv6 network range for the account in CIDR format.
</Property>
<Property name="peer_expose_enabled" type="boolean" required={true}>
@@ -583,6 +604,16 @@ echo $response;
Indicates whether local (email/password) authentication is disabled. When true, users can only authenticate via external identity providers. This is a read-only field.
</Property>
<Property name="local_mfa_enabled" type="boolean" required={false}>
Enables or disables TOTP multi-factor authentication for local users. Only applicable when the embedded identity provider is enabled.
</Property>
<Property name="ipv6_enabled_groups" type="string[]" required={false}>
List of group IDs whose peers receive IPv6 overlay addresses. Peers not in any of these groups will not be allocated an IPv6 address. New accounts default to the All group.
</Property>
</Properties>
@@ -639,7 +670,12 @@ curl -X PUT https://api.netbird.io/api/accounts/{accountId} \
],
"routing_peer_dns_resolution_enabled": true,
"dns_domain": "my-organization.org",
"network_range": "100.64.0.0/16",
"network_range": {
"description": "Allows to define a custom network range for the account in CIDR format",
"type": "string",
"format": "cidr"
},
"network_range_v6": "fd00:1234:5678::/64",
"peer_expose_enabled": false,
"peer_expose_groups": [
"ch8i4ug6lnn4g9hqv7m0"
@@ -657,7 +693,11 @@ curl -X PUT https://api.netbird.io/api/accounts/{accountId} \
"auto_update_version": "0.51.2",
"auto_update_always": false,
"embedded_idp_enabled": false,
"local_auth_disabled": false
"local_auth_disabled": false,
"local_mfa_enabled": false,
"ipv6_enabled_groups": [
"ch8i4ug6lnn4g9hqv7m0"
]
},
"onboarding": {
"signup_form_pending": true,
@@ -683,7 +723,12 @@ let data = JSON.stringify({
],
"routing_peer_dns_resolution_enabled": true,
"dns_domain": "my-organization.org",
"network_range": "100.64.0.0/16",
"network_range": {
"description": "Allows to define a custom network range for the account in CIDR format",
"type": "string",
"format": "cidr"
},
"network_range_v6": "fd00:1234:5678::/64",
"peer_expose_enabled": false,
"peer_expose_groups": [
"ch8i4ug6lnn4g9hqv7m0"
@@ -701,7 +746,11 @@ let data = JSON.stringify({
"auto_update_version": "0.51.2",
"auto_update_always": false,
"embedded_idp_enabled": false,
"local_auth_disabled": false
"local_auth_disabled": false,
"local_mfa_enabled": false,
"ipv6_enabled_groups": [
"ch8i4ug6lnn4g9hqv7m0"
]
},
"onboarding": {
"signup_form_pending": true,
@@ -749,7 +798,12 @@ payload = json.dumps({
],
"routing_peer_dns_resolution_enabled": true,
"dns_domain": "my-organization.org",
"network_range": "100.64.0.0/16",
"network_range": {
"description": "Allows to define a custom network range for the account in CIDR format",
"type": "string",
"format": "cidr"
},
"network_range_v6": "fd00:1234:5678::/64",
"peer_expose_enabled": false,
"peer_expose_groups": [
"ch8i4ug6lnn4g9hqv7m0"
@@ -767,7 +821,11 @@ payload = json.dumps({
"auto_update_version": "0.51.2",
"auto_update_always": false,
"embedded_idp_enabled": false,
"local_auth_disabled": false
"local_auth_disabled": false,
"local_mfa_enabled": false,
"ipv6_enabled_groups": [
"ch8i4ug6lnn4g9hqv7m0"
]
},
"onboarding": {
"signup_form_pending": true,
@@ -815,7 +873,12 @@ func main() {
],
"routing_peer_dns_resolution_enabled": true,
"dns_domain": "my-organization.org",
"network_range": "100.64.0.0/16",
"network_range": {
"description": "Allows to define a custom network range for the account in CIDR format",
"type": "string",
"format": "cidr"
},
"network_range_v6": "fd00:1234:5678::/64",
"peer_expose_enabled": false,
"peer_expose_groups": [
"ch8i4ug6lnn4g9hqv7m0"
@@ -833,7 +896,11 @@ func main() {
"auto_update_version": "0.51.2",
"auto_update_always": false,
"embedded_idp_enabled": false,
"local_auth_disabled": false
"local_auth_disabled": false,
"local_mfa_enabled": false,
"ipv6_enabled_groups": [
"ch8i4ug6lnn4g9hqv7m0"
]
},
"onboarding": {
"signup_form_pending": true,
@@ -849,6 +916,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -899,7 +967,12 @@ request.body = JSON.dump({
],
"routing_peer_dns_resolution_enabled": true,
"dns_domain": "my-organization.org",
"network_range": "100.64.0.0/16",
"network_range": {
"description": "Allows to define a custom network range for the account in CIDR format",
"type": "string",
"format": "cidr"
},
"network_range_v6": "fd00:1234:5678::/64",
"peer_expose_enabled": false,
"peer_expose_groups": [
"ch8i4ug6lnn4g9hqv7m0"
@@ -917,7 +990,11 @@ request.body = JSON.dump({
"auto_update_version": "0.51.2",
"auto_update_always": false,
"embedded_idp_enabled": false,
"local_auth_disabled": false
"local_auth_disabled": false,
"local_mfa_enabled": false,
"ipv6_enabled_groups": [
"ch8i4ug6lnn4g9hqv7m0"
]
},
"onboarding": {
"signup_form_pending": true,
@@ -947,7 +1024,12 @@ RequestBody body = RequestBody.create(mediaType, '{
],
"routing_peer_dns_resolution_enabled": true,
"dns_domain": "my-organization.org",
"network_range": "100.64.0.0/16",
"network_range": {
"description": "Allows to define a custom network range for the account in CIDR format",
"type": "string",
"format": "cidr"
},
"network_range_v6": "fd00:1234:5678::/64",
"peer_expose_enabled": false,
"peer_expose_groups": [
"ch8i4ug6lnn4g9hqv7m0"
@@ -965,7 +1047,11 @@ RequestBody body = RequestBody.create(mediaType, '{
"auto_update_version": "0.51.2",
"auto_update_always": false,
"embedded_idp_enabled": false,
"local_auth_disabled": false
"local_auth_disabled": false,
"local_mfa_enabled": false,
"ipv6_enabled_groups": [
"ch8i4ug6lnn4g9hqv7m0"
]
},
"onboarding": {
"signup_form_pending": true,
@@ -1011,7 +1097,12 @@ curl_setopt_array($curl, array(
],
"routing_peer_dns_resolution_enabled": true,
"dns_domain": "my-organization.org",
"network_range": "100.64.0.0/16",
"network_range": {
"description": "Allows to define a custom network range for the account in CIDR format",
"type": "string",
"format": "cidr"
},
"network_range_v6": "fd00:1234:5678::/64",
"peer_expose_enabled": false,
"peer_expose_groups": [
"ch8i4ug6lnn4g9hqv7m0"
@@ -1029,7 +1120,11 @@ curl_setopt_array($curl, array(
"auto_update_version": "0.51.2",
"auto_update_always": false,
"embedded_idp_enabled": false,
"local_auth_disabled": false
"local_auth_disabled": false,
"local_mfa_enabled": false,
"ipv6_enabled_groups": [
"ch8i4ug6lnn4g9hqv7m0"
]
},
"onboarding": {
"signup_form_pending": true,
@@ -1070,7 +1165,12 @@ echo $response;
],
"routing_peer_dns_resolution_enabled": true,
"dns_domain": "my-organization.org",
"network_range": "100.64.0.0/16",
"network_range": {
"description": "Allows to define a custom network range for the account in CIDR format",
"type": "string",
"format": "cidr"
},
"network_range_v6": "fd00:1234:5678::/64",
"peer_expose_enabled": false,
"peer_expose_groups": [
"ch8i4ug6lnn4g9hqv7m0"
@@ -1088,7 +1188,11 @@ echo $response;
"auto_update_version": "0.51.2",
"auto_update_always": false,
"embedded_idp_enabled": false,
"local_auth_disabled": false
"local_auth_disabled": false,
"local_mfa_enabled": false,
"ipv6_enabled_groups": [
"ch8i4ug6lnn4g9hqv7m0"
]
},
"domain": "netbird.io",
"domain_category": "private",
@@ -1118,6 +1222,7 @@ echo $response;
"routing_peer_dns_resolution_enabled": "boolean",
"dns_domain": "string",
"network_range": "string",
"network_range_v6": "string",
"peer_expose_enabled": "boolean",
"peer_expose_groups": [
"string"
@@ -1135,7 +1240,11 @@ echo $response;
"auto_update_version": "string",
"auto_update_always": "boolean",
"embedded_idp_enabled": "boolean",
"local_auth_disabled": "boolean"
"local_auth_disabled": "boolean",
"local_mfa_enabled": "boolean",
"ipv6_enabled_groups": [
"string"
]
},
"domain": "string",
"domain_category": "string",

10
src/pages/ipa/resources/dns-zones.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -380,6 +381,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -642,6 +644,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -948,6 +951,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1207,6 +1211,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1374,6 +1379,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1623,6 +1629,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1840,6 +1847,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2089,6 +2097,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2303,6 +2312,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

7
src/pages/ipa/resources/dns.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -445,6 +446,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -728,6 +730,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1099,6 +1102,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1379,6 +1383,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1538,6 +1543,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1756,6 +1762,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

4
src/pages/ipa/resources/edr-falcon-integrations.mdx
View File

@@ -217,6 +217,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -541,6 +542,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -926,6 +928,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1247,6 +1250,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

4
src/pages/ipa/resources/edr-fleetdm-integrations.mdx
View File

@@ -317,6 +317,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -719,6 +720,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1231,6 +1233,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1633,6 +1636,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

4
src/pages/ipa/resources/edr-huntress-integrations.mdx
View File

@@ -268,6 +268,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -618,6 +619,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1062,6 +1064,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1412,6 +1415,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

4
src/pages/ipa/resources/edr-intune-integrations.mdx
View File

@@ -234,6 +234,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -569,6 +570,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -970,6 +972,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1305,6 +1308,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

3
src/pages/ipa/resources/edr-peers.mdx
View File

@@ -81,6 +81,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -254,6 +255,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -413,6 +415,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

4
src/pages/ipa/resources/edr-sentinelone-integrations.mdx
View File

@@ -408,6 +408,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -886,6 +887,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1508,6 +1510,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1986,6 +1989,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

5
src/pages/ipa/resources/event-streaming-integrations.mdx
View File

@@ -147,6 +147,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -381,6 +382,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -586,6 +588,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -855,6 +858,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1089,6 +1093,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

3
src/pages/ipa/resources/events.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -335,6 +336,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -707,6 +709,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

2
src/pages/ipa/resources/geo-locations.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -262,6 +263,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

5
src/pages/ipa/resources/groups.mdx
View File

@@ -86,6 +86,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -387,6 +388,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -642,6 +644,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -947,6 +950,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1199,6 +1203,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

5
src/pages/ipa/resources/identity-providers.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -328,6 +329,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -544,6 +546,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -798,6 +801,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1011,6 +1015,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

7
src/pages/ipa/resources/idp-azure-integrations.mdx
View File

@@ -199,6 +199,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -462,6 +463,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -672,6 +674,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1051,6 +1054,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1353,6 +1357,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1528,6 +1533,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1704,6 +1710,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

7
src/pages/ipa/resources/idp-google-integrations.mdx
View File

@@ -181,6 +181,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -434,6 +435,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -640,6 +642,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -994,6 +997,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1280,6 +1284,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1455,6 +1460,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1631,6 +1637,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

7
src/pages/ipa/resources/idp-okta-scim-integrations.mdx
View File

@@ -163,6 +163,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -408,6 +409,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -612,6 +614,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -897,6 +900,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1142,6 +1146,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1317,6 +1322,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1493,6 +1499,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

7
src/pages/ipa/resources/idp-scim-integrations.mdx
View File

@@ -196,6 +196,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -472,6 +473,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -686,6 +688,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1002,6 +1005,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1269,6 +1273,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1444,6 +1449,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1620,6 +1626,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

10
src/pages/ipa/resources/ingress-ports.mdx
View File

@@ -94,6 +94,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -438,6 +439,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -702,6 +704,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1046,6 +1049,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1307,6 +1311,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1466,6 +1471,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1710,6 +1716,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1932,6 +1939,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2171,6 +2179,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2387,6 +2396,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

3
src/pages/ipa/resources/instance.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -254,6 +255,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -501,6 +503,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

3
src/pages/ipa/resources/invoice.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -279,6 +280,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -460,6 +462,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

3
src/pages/ipa/resources/jobs.mdx
View File

@@ -86,6 +86,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -447,6 +448,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -688,6 +690,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

8
src/pages/ipa/resources/msp.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -367,6 +368,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -684,6 +686,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -949,6 +952,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1125,6 +1129,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1315,6 +1320,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1494,6 +1500,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1757,6 +1764,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

16
src/pages/ipa/resources/networks.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -317,6 +318,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -540,6 +542,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -783,6 +786,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1003,6 +1007,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1170,6 +1175,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1456,6 +1462,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1702,6 +1709,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1988,6 +1996,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2231,6 +2240,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2398,6 +2408,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2670,6 +2681,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2902,6 +2914,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -3174,6 +3187,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -3403,6 +3417,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -3562,6 +3577,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

6
src/pages/ipa/resources/notifications.mdx
View File

@@ -81,6 +81,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -262,6 +263,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -636,6 +638,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -948,6 +951,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1316,6 +1320,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1628,6 +1633,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

40
src/pages/ipa/resources/peers.mdx
View File

@@ -90,6 +90,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -178,6 +179,7 @@ echo $response;
"name": "stage-host-1",
"created_at": "2023-05-05T09:00:35.477782Z",
"ip": "10.64.0.1",
"ipv6": "fd00:4e42:ab12::1",
"connection_ip": "35.64.0.1",
"connected": true,
"last_seen": "2023-05-05T10:05:26.420578Z",
@@ -238,6 +240,7 @@ echo $response;
"name": "string",
"created_at": "string",
"ip": "string",
"ipv6": "string",
"connection_ip": "string",
"connected": "boolean",
"last_seen": "string",
@@ -381,6 +384,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -468,6 +472,7 @@ echo $response;
"name": "stage-host-1",
"created_at": "2023-05-05T09:00:35.477782Z",
"ip": "10.64.0.1",
"ipv6": "fd00:4e42:ab12::1",
"connection_ip": "35.64.0.1",
"connected": true,
"last_seen": "2023-05-05T10:05:26.420578Z",
@@ -525,6 +530,7 @@ echo $response;
"name": "string",
"created_at": "string",
"ip": "string",
"ipv6": "string",
"connection_ip": "string",
"connected": "boolean",
"last_seen": "string",
@@ -627,6 +633,11 @@ echo $response;
Peer's IP address
</Property>
<Property name="ipv6" type="string" required={false}>
Peer's IPv6 overlay address. Omitted if IPv6 is not enabled for the account.
</Property>
</Properties>
@@ -646,7 +657,8 @@ curl -X PUT https://api.netbird.io/api/peers/{peerId} \
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true,
"ip": "100.64.0.15"
"ip": "100.64.0.15",
"ipv6": "fd00:4e42:ab12::1"
}'
```
@@ -658,7 +670,8 @@ let data = JSON.stringify({
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true,
"ip": "100.64.0.15"
"ip": "100.64.0.15",
"ipv6": "fd00:4e42:ab12::1"
});
let config = {
method: 'put',
@@ -692,7 +705,8 @@ payload = json.dumps({
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true,
"ip": "100.64.0.15"
"ip": "100.64.0.15",
"ipv6": "fd00:4e42:ab12::1"
})
headers = {
'Content-Type': 'application/json',
@@ -726,7 +740,8 @@ func main() {
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true,
"ip": "100.64.0.15"
"ip": "100.64.0.15",
"ipv6": "fd00:4e42:ab12::1"
}`)
client := &http.Client {
}
@@ -737,6 +752,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -778,7 +794,8 @@ request.body = JSON.dump({
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true,
"ip": "100.64.0.15"
"ip": "100.64.0.15",
"ipv6": "fd00:4e42:ab12::1"
})
response = https.request(request)
puts response.read_body
@@ -794,7 +811,8 @@ RequestBody body = RequestBody.create(mediaType, '{
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true,
"ip": "100.64.0.15"
"ip": "100.64.0.15",
"ipv6": "fd00:4e42:ab12::1"
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/peers/{peerId}")
@@ -826,7 +844,8 @@ curl_setopt_array($curl, array(
"login_expiration_enabled": false,
"inactivity_expiration_enabled": false,
"approval_required": true,
"ip": "100.64.0.15"
"ip": "100.64.0.15",
"ipv6": "fd00:4e42:ab12::1"
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
@@ -851,6 +870,7 @@ echo $response;
"name": "stage-host-1",
"created_at": "2023-05-05T09:00:35.477782Z",
"ip": "10.64.0.1",
"ipv6": "fd00:4e42:ab12::1",
"connection_ip": "35.64.0.1",
"connected": true,
"last_seen": "2023-05-05T10:05:26.420578Z",
@@ -908,6 +928,7 @@ echo $response;
"name": "string",
"created_at": "string",
"ip": "string",
"ipv6": "string",
"connection_ip": "string",
"connected": "boolean",
"last_seen": "string",
@@ -1046,6 +1067,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1213,6 +1235,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1300,6 +1323,7 @@ echo $response;
"id": "chacbco6lnnbn6cg5s90",
"name": "stage-host-1",
"ip": "10.64.0.1",
"ipv6": "fd00:4e42:ab12::1",
"dns_label": "stage-host-1.netbird.cloud",
"user_id": "google-oauth2|277474792786460067937",
"os": "linux",
@@ -1317,6 +1341,7 @@ echo $response;
"id": "string",
"name": "string",
"ip": "string",
"ipv6": "string",
"dns_label": "string",
"user_id": "string",
"os": "string",
@@ -1473,6 +1498,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

5
src/pages/ipa/resources/policies.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -734,6 +735,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1186,6 +1188,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1846,6 +1849,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2295,6 +2299,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

5
src/pages/ipa/resources/posture-checks.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -819,6 +820,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1268,6 +1270,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2013,6 +2016,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2459,6 +2463,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

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

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -468,6 +469,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -768,6 +770,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1162,6 +1165,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1459,6 +1463,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

627
src/pages/ipa/resources/self-hosted-proxies.mdx Normal file
View File

@@ -0,0 +1,627 @@
export const title = 'Self-Hosted Proxies'
## List Proxy Tokens {{ tag: 'GET' , label: '/api/reverse-proxies/proxy-tokens' }}
<Row>
<Col>
Returns all proxy access tokens for the account
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/reverse-proxies/proxy-tokens">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/reverse-proxies/proxy-tokens \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/reverse-proxies/proxy-tokens',
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/reverse-proxies/proxy-tokens"
headers = {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/reverse-proxies/proxy-tokens"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/reverse-proxies/proxy-tokens")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.netbird.io/api/reverse-proxies/proxy-tokens")
.method("GET")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/reverse-proxies/proxy-tokens',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
[
{
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_used": {
"type": "string",
"format": "date-time"
},
"revoked": {
"type": "boolean"
}
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
"name": "string",
"expires_at": "string",
"created_at": "string",
"last_used": "string",
"revoked": "boolean"
}
]
```
</CodeGroup>
</Col>
</Row>
---
## Create a Proxy Token {{ tag: 'POST' , label: '/api/reverse-proxies/proxy-tokens' }}
<Row>
<Col>
Generate an account-scoped proxy access token for self-hosted proxy registration
### Request-Body Parameters
<Properties><Property name="name" type="string" required={true}>
Human-readable token name
</Property>
<Property name="expires_in" type="integer" required={false} min={0}>
Token expiration in seconds (0 = never expires)
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="POST" label="/api/reverse-proxies/proxy-tokens">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/reverse-proxies/proxy-tokens \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
"name": "my-proxy-token",
"expires_in": 0
}'
```
```js
const axios = require('axios');
let data = JSON.stringify({
"name": "my-proxy-token",
"expires_in": 0
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: '/api/reverse-proxies/proxy-tokens',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Token <TOKEN>'
},
data : data
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/reverse-proxies/proxy-tokens"
payload = json.dumps({
"name": "my-proxy-token",
"expires_in": 0
})
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/reverse-proxies/proxy-tokens"
method := "POST"
payload := strings.NewReader(`{
"name": "my-proxy-token",
"expires_in": 0
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/reverse-proxies/proxy-tokens")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
request.body = JSON.dump({
"name": "my-proxy-token",
"expires_in": 0
})
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, '{
"name": "my-proxy-token",
"expires_in": 0
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/reverse-proxies/proxy-tokens")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/reverse-proxies/proxy-tokens',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => '{
"name": "my-proxy-token",
"expires_in": 0
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"last_used": {
"type": "string",
"format": "date-time"
},
"revoked": {
"type": "boolean"
},
"plain_token": "nbx_abc123..."
}
```
```json {{ title: 'Schema' }}
{
"id": "string",
"name": "string",
"expires_at": "string",
"created_at": "string",
"last_used": "string",
"revoked": "boolean",
"plain_token": "string"
}
```
</CodeGroup>
</Col>
</Row>
---
## Revoke a Proxy Token {{ tag: 'DELETE' , label: '/api/reverse-proxies/proxy-tokens/{tokenId}' }}
<Row>
<Col>
Revoke an account-scoped proxy access token
### Path Parameters
<Properties>
<Property name="tokenId" type="string" required={true}>
The unique identifier of the proxy token
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/reverse-proxies/proxy-tokens/{tokenId}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/reverse-proxies/proxy-tokens/{tokenId} \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'delete',
maxBodyLength: Infinity,
url: '/api/reverse-proxies/proxy-tokens/{tokenId}',
headers: {
'Authorization': 'Token <TOKEN>'
}
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/reverse-proxies/proxy-tokens/{tokenId}"
headers = {
'Authorization': 'Token <TOKEN>'
}
response = requests.request("DELETE", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/reverse-proxies/proxy-tokens/{tokenId}"
method := "DELETE"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/reverse-proxies/proxy-tokens/{tokenId}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = "Token <TOKEN>"
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.netbird.io/api/reverse-proxies/proxy-tokens/{tokenId}")
.method("DELETE")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/reverse-proxies/proxy-tokens/{tokenId}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
</Col>
</Row>
---

183
src/pages/ipa/resources/services.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -162,16 +163,20 @@ echo $response;
```json {{ title: 'Example' }}
[
{
"id": "chlfq4q5r8kc73b0qjpg",
"address": "eu.proxy.netbird.io",
"connected_proxies": 3
"connected_proxies": 3,
"self_hosted": false
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "string",
"address": "string",
"connected_proxies": "integer"
"connected_proxies": "integer",
"self_hosted": "boolean"
}
]
```
@@ -184,6 +189,171 @@ echo $response;
---
## Delete a self-hosted proxy cluster {{ tag: 'DELETE' , label: '/api/reverse-proxies/clusters/{clusterAddress}' }}
<Row>
<Col>
Removes all self-hosted (BYOP) proxy registrations for the given cluster address owned by the account.
### Path Parameters
<Properties>
<Property name="clusterAddress" type="string" required={true}>
The address of the proxy cluster
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/reverse-proxies/clusters/{clusterAddress}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/reverse-proxies/clusters/{clusterAddress} \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'delete',
maxBodyLength: Infinity,
url: '/api/reverse-proxies/clusters/{clusterAddress}',
headers: {
'Authorization': 'Token <TOKEN>'
}
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/reverse-proxies/clusters/{clusterAddress}"
headers = {
'Authorization': 'Token <TOKEN>'
}
response = requests.request("DELETE", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/reverse-proxies/clusters/{clusterAddress}"
method := "DELETE"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/reverse-proxies/clusters/{clusterAddress}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = "Token <TOKEN>"
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.netbird.io/api/reverse-proxies/clusters/{clusterAddress}")
.method("DELETE")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/reverse-proxies/clusters/{clusterAddress}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
</Col>
</Row>
---
## List all Services {{ tag: 'GET' , label: '/api/reverse-proxies/services' }}
<Row>
@@ -260,6 +430,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1221,6 +1392,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1817,6 +1989,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2782,6 +2955,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -3375,6 +3549,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -3534,6 +3709,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -3763,6 +3939,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -4128,6 +4305,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -4292,6 +4470,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

5
src/pages/ipa/resources/setup-keys.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -378,6 +379,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -630,6 +632,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -889,6 +892,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1123,6 +1127,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

4
src/pages/ipa/resources/tokens.mdx
View File

@@ -86,6 +86,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -319,6 +320,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -538,6 +540,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -733,6 +736,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")

1
src/pages/ipa/resources/usage.mdx
View File

@@ -78,6 +78,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")

15
src/pages/ipa/resources/users.mdx
View File

@@ -86,6 +86,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -412,6 +413,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -754,6 +756,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1035,6 +1038,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1199,6 +1203,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1366,6 +1371,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1623,6 +1629,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1822,6 +1829,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -1996,6 +2004,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2248,6 +2257,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2518,6 +2528,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2749,6 +2760,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -2942,6 +2954,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -3140,6 +3153,7 @@ func main() {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
@@ -3358,6 +3372,7 @@ func main() {
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")