Edge-LB API Reference

Reference for all API endpoints exposed by the Edge-LB package

The Edge-LB API enables users to create and manage pools of load balancers.

Compatibility

The Edge-LB API was initially released alongside DC/OS 1.10.0 and requires DC/OS Enterprise 1.10.0 or later.

API Versions

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.

The V1 and V2 specifications were merged into a single spec; however, there are still separate v1 and v2 docs for reference configs, pool examples, etc.

Routes

Access to the Edge-LB API is proxied through the Admin Router on the master nodes using the following route by default:

/service/edgelb/

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 /service/edgelb-emea.

To determine the address of your cluster, see Cluster Access.

Auth

All Edge-LB API routes require authentication to use.

To authenticate API requests, see Obtaining an authentication token and Passing an authentication token.

The Edge-LB API also requires authorization via the following permissions:

Route Permission
/service/edgelb/ dcos:adminrouter:service:edge-lb

All routes may also be reached by users with the dcos:superuser permission.

To assign permissions to your account, see Assigning permissions.

API specification

The following resources are available: