The Edge-LB API enables users to create and manage pools of load balancers.
The Edge-LB API was initially released alongside DC/OS 1.10.0 and requires DC/OS Enterprise 1.10.0 or later.
A new top level configuration field named
apiVersion was introduced in Edge-LB v1.0.0. The two models are almost identical, with one important difference:
pool.haproxy.backends.servers (in apiVersion
V1) has been replaced with
pool.haproxy.backends.services, with a more intuitive way to select services/backends for HAProxy.
Access to the Edge-LB API is proxied through the Admin Router on the master nodes using the following route by default:
Keep in mind that the path to Edge-LB endpoints might be different if you have change the service name. For example, if you have changed the default Edge-LB service name to append a geographic location, such as
edgelb-emea, then the path to the service would be
To determine the address of your cluster, see Cluster Access.
All Edge-LB API routes require authentication to use.
The Edge-LB API also requires authorization via the following permissions:
All routes may also be reached by users with the
To assign permissions to your account, see Assigning permissions.
The following resources are available: