}}

Marathon REST API

Enterprise DC/OS Updated: June 2, 2017

The Marathon API allows you to manage long-running containerized services (apps and pods).

The Marathon API is backed by the Marathon component, which runs on the master nodes.

One of the Marathon instances is elected as leader, while the rest are hot backups in case of failure. All API requests must go through the Marathon leader. To enforce this, Admin Router proxies requests from any master node to the Marathon leader.

For more information about using Marathon, see Managing Services.

Routes

Access to the Marathon API is proxied through the Admin Router on each master node using the following route:

/service/marathon/

Auth

All Marathon API routes require authentication to use.

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

The Marathon API also requires authorization via the following permissions:

Route Permission
/service/marathon/ dcos:adminrouter:service:marathon

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

To assign permissions to your account, see the permissions reference.

Resources

 
Loading ...