GET
/api/reverse-proxies/servicesList reverse proxy services
Lists the reverse proxy services configured for the account, including their domains, modes, enabled status, authentication settings, and targets. Use the service details to review how each service routes and controls access to backend resources.
200Returns an array of reverse proxy service objects, including each service's identifier, name, domain, enabled status, authentication configuration, metadata, and targets.
access_groupsarray<string>optional
NetBird group IDs whose peers may reach this private service over the tunnel. Required when private=true; ignored otherwise. Mutually exclusive with bearer auth (SSO).
access_restrictionsobjectoptional
Connection-level access restrictions based on IP address or geography. Applies to both HTTP and L4 services.
authobjectrequired
domainstringrequired
Domain for the service
enabledbooleanrequired
Whether the service is enabled
idstringrequired
Service ID
listen_portintegeroptional
Port the proxy listens on (L4/TLS only)
metaobjectrequired
modestringoptional
Service mode. "http" for L7 reverse proxy, "tcp"/"udp"/"tls" for L4 passthrough.
namestringrequired
Service name
pass_host_headerbooleanoptional
When true, the original client Host header is passed through to the backend instead of being rewritten to the backend's address
port_auto_assignedbooleanoptional
Whether the listen port was auto-assigned
privatebooleanoptional
When true, the service is NetBird-only — its target points at a proxy cluster, inbound peers authenticate via their WireGuard tunnel identity (no OIDC), and an ACL policy is auto-generated from access_groups to the cluster's proxy-peer group. Requires mode=http.
proxy_clusterstringoptional
The proxy cluster handling this service (derived from domain)
rewrite_redirectsbooleanoptional
When true, Location headers in backend responses are rewritten to replace the backend address with the public-facing domain
targetsarray<object>required
List of target backends for this service
terminatedbooleanoptional
Whether the service has been terminated. Terminated services cannot be updated. Services that violate the Terms of Service will be terminated.
401Returned when the request lacks authentication.
403Returned when the authenticated user is forbidden from listing services.
500Returned when an internal server error occurs.
Error handling
A 401 is returned when the request lacks valid authentication credentials. A 403 is returned when the authenticated user is not permitted to list services. A 500 indicates an internal server error.