NetBird Full API Reference + Read-Only MCP Prototype
GET/api/reverse-proxies/clusters

List available proxy clusters

Returns a list of available proxy clusters with their connection status

4 status codes
200A JSON Array of proxy clusters
addressstringrequired
Cluster address used for CNAME targets
connected_proxiesintegerrequired
Number of proxy nodes currently connected (heartbeat within the active window)
idstringrequired
Unique identifier of a proxy in this cluster
onlinebooleanrequired
Whether at least one proxy in the cluster has heartbeated within the active window
privatebooleanoptional
True when at least one connected proxy in this cluster is running embedded in a netbird client (`netbird proxy`) and serving over a WireGuard tunnel. Lets the dashboard distinguish per-peer / private clusters from centralised ones.
require_subdomainbooleanoptional
Whether services on this cluster must include a subdomain label
supports_crowdsecbooleanoptional
Whether all active proxies in the cluster have CrowdSec configured
supports_custom_portsbooleanoptional
Whether the cluster supports binding arbitrary TCP/UDP ports
typestringrequired
Source of the proxy cluster. `account` clusters are owned and operated by the account (BYOP); `shared` clusters are operated by NetBird and shared across accounts.
Allowed:accountshared
401Requires authentication
403Forbidden
500Internal Server Error

Error handling

A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 500 is returned: Internal Server Error.