Master Routes

The Admin Router runs on DC/OS master nodes. It exposes the API routes shown below. Admin Router listens on port 80 (HTTP) and 443 (HTTPS).

For more detail about how API routing works, see DC/OS API Reference.

Show/Hide All

Proxy retrieves resources from another address.
File retrieves static files.
Lua executes Lua code to generate response.
Redirect redirects to another address.
Rewrite retrieves resources from another route.

Show/Hide
- File /
  DC/OS GUI
  
  Path: /opt/mesosphere/active/dcos-ui/usr
Show/Hide
- Proxy /(slave|agent)/(?<agentid>[0-9a-zA-Z-]+)(?<url>.+)
  API proxy to a specific agent node
  
  Rewrite:
  
  Regex: ^/(slave|agent)/[0-9a-zA-Z-]+/.*$
  
  Replacement: $url
  
  Type: break
  
  Proxy:
  
  Path: $agentaddr:$agentport

Show/Hide

File /acs/acl-schema.json
Access Control List schema

Path: /opt/mesosphere/active/acl-schema/etc/acl-schema.json

Proxy `/acs/api/v1`

Access Control Service

Proxy `/acs/api/v1/auth/(login|logout|jwks|providers|oidc/callback|oidc/providers/?|saml/providers/?)`

Access Control Service (unauthenticated)

Proxy `/acs/api/v1/auth/saml/providers/[0-9a-zA-Z-]+/acs-callback`

Access Control Service SAML provider callback (unauthenticated)

Proxy `/acs/api/v1/users/(?<uid_path>.*)/permissions`

Access Control List schema

Proxy `/internal/acs/api/v1/`

Access Control Service policy query (unauthenticated, internal-only)

Show/Hide
- Proxy /capabilities
  List of capabilities supported by DC/OS
  
  Path: $upstream_cosmos

Show/Hide

Proxy `/ca/api/v2/(newcert|newkey|sign)`

Certificate Signing Request (CSR)

Proxy `/ca/api/v2/bundle`

Retrieve certificate chain without root CA cert for provided certificate

Proxy `/ca/api/v2/info`

Certificate and basic signing information

File /ca/cacerts.jks
Get CA public key Java Key Store file (unauthenticated)

Path: /run/dcos/pki/CA/certs/cacerts.jks
File /ca/dcos-ca.crt
Get CA public key Privacy Enhanced Mail file (unauthenticated)

Path: /run/dcos/pki/CA/ca-bundle.crt

Show/Hide

Proxy `/cluster/`

Allow access to Cluster APIs

Show/Hide
- Redirect /cockroachdb
  Redirect to the CockroachDB Admin UI
  
  Regex: ^/cockroachdb$
  
  Replacement: $scheme://$http_host/cockroachdb/
  
  Type: permanent
- Proxy /cockroachdb/
  The CockroachDB Admin UI
  
  Path: https://$backend/
  
  Server: 127.0.0.1:8090
  
  Backend: CockroachDB
  
  API Reference: https://www.cockroachlabs.com/
Show/Hide
- Proxy /cosmos/service/
  Start a DC/OS service from a DC/OS package
  
  Rewrite:
  
  Regex: ^/cosmos/(.*)
  
  Replacement: /$1
  
  Type: break
  
  Proxy:
  
  Path: $upstream_cosmos
Show/Hide
- Proxy /navstar/lashup/key
  
  Path: http://$backend/lashup/key
  
  Server: 127.0.0.1:62080
  
  Backend: DC/OS Net

Show/Hide

Proxy /exhibitor/
Manage Zookeeper

Path: http://$backend/

Server: 127.0.0.1:8181

Backend: Exhibitor (Zookeeper)

API Reference: https://github.com/soabase/exhibitor/wiki/REST-Introduction

Proxy `/exhibitor/exhibitor/v1/cluster/status`

Exhibitor cluster status (unauthenticated)

Show/Hide
- Rewrite /marathon/
  
  Rewrite:
  
  Regex: ^/marathon/(.*)$
  
  Replacement: /service/marathon/$1
  
  Type: last
  
  Deprecated: Use /service/marathon/
Show/Hide
- Proxy /mesos/
  Apache Mesos
  
  Rewrite:
  
  Regex: ^/mesos/(.*)
  
  Replacement: /$1
  
  Type: break
  
  Proxy:
  
  Path: $upstream_mesos
Show/Hide
- Proxy /mesos_dns/
  Domain-based service discovery
  
  Path: http://$backend/
  
  Server: 127.0.0.1:8123
  
  Backend: Mesos DNS
  
  API Reference: https://docs.d2iq.com/mesosphere/dcos/2.2/networking/DNS/mesos-dns/mesos-dns-api/
Show/Hide
- File /dcos-metadata/bootstrap-config.json
  DC/OS bootstrap configuration
  
  Path: /opt/mesosphere/etc/bootstrap-config.json
- File /dcos-metadata/dcos-version.json
  DC/OS version (unauthenticated)
  
  Path: /opt/mesosphere/active/dcos-metadata/etc/dcos-version.json
- File /dcos-metadata/ui-config.json
  DC/OS GUI configuration (unauthenticated)
  
  Path: /opt/mesosphere/etc/ui-config.json
- Lua /metadata
  Public IP and Cluster ID
  
  Path: conf/lib/metadata.lua
Show/Hide
- Proxy /net/v1/nodes
  Exposes the public IP addresses for nodes in a cluster
  
  Path: null
Show/Hide
- Proxy /networking/api/v1/
  Networking-related metrics
  
  Rewrite:
  
  Regex: ^/networking/api/v1/(.*)
  
  Replacement: /$1
  
  Type: break
  
  Proxy:
  
  Path: $upstream_dcos_netapi
Show/Hide
- Proxy /internal/mesos_dns/
  
  Path: http://$backend/
  
  Server: 127.0.0.1:8123
  
  Backend: Mesos DNS
  
  API Reference: https://docs.d2iq.com/mesosphere/dcos/2.2/networking/DNS/mesos-dns/mesos-dns-api/
Show/Hide
- Proxy /package/
  Package Management
  
  Path: $upstream_cosmos

Show/Hide

Proxy `/pkgpanda/`

DC/OS component package management

File /pkgpanda/active.buildinfo.full.json
List the active Pkgpanda packages

Path: /opt/mesosphere/active.buildinfo.full.json

Show/Hide
- Proxy /secrets/v1/
  Securely store and retrieve secrets
  
  Path: $upstream_secrets
Show/Hide
- Proxy /service/(?<service_path>.+)
  Proxy to services running on DC/OS
  
  Path: $upstream_url

Show/Hide

Proxy `/system/health/v1`

Component service status

Proxy `/system/v1/agent/(?<agentid>[0-9a-zA-Z-]+)(?<url>/logs.|/metrics/v0.|/dcos-metadata/dcos-version.json)`

System proxy to a specific agent node

Proxy `/system/v1/backup/`

Backup & Restore DC/OS Components

Proxy /system/v1/leader/marathon(?<url>.*)
System proxy to the master node with the Marathon leader

Path: $mleader_host/system/v1$url$is_args$query_string
Proxy /system/v1/leader/mesos(?<url>.*)
System proxy to the master node with the Mesos leader

Path: $system_v1_leader_mesos
Proxy /system/v1/logs/
Node, component service, and container (task) logs

Path: http://$backend

Server: unix:/run/dcos/dcos-log.sock

Backend: DC/OS Log

API Reference: https://docs.d2iq.com/mesosphere/dcos/2.2/monitoring/logging/logging-reference/
Proxy /system/v1/metrics/
Node, container, and application metrics

Path: http://$backend

Server: unix:/run/dcos/dcos-metrics-master.sock

Backend: DC/OS Metrics

API Reference: https://docs.d2iq.com/mesosphere/dcos/2.2/metrics/metrics-api/

Path:	`http://$backend/acs/api/v1`
Server:	`127.0.0.1:8101`
Backend:	DC/OS Identity and Access Manager (Bouncer)
API Reference:	https://docs.d2iq.com/mesosphere/dcos/2.2/security/ent/iam-api/

Path:	`http://$backend~ ^/acs/api/v1/auth/(login\|logout\|jwks\|providers\|oidc/callback\|oidc/providers/?\|saml/providers/?)$`
Server:	`127.0.0.1:8101`
Backend:	DC/OS Identity and Access Manager (Bouncer)
API Reference:	https://docs.d2iq.com/mesosphere/dcos/2.2/security/ent/iam-api/

Path:	`http://$backend~ ^/acs/api/v1/auth/saml/providers/[0-9a-zA-Z-]+/acs-callback$`
Server:	`127.0.0.1:8101`
Backend:	DC/OS Identity and Access Manager (Bouncer)
API Reference:	https://docs.d2iq.com/mesosphere/dcos/2.2/security/ent/iam-api/

Path:	`http://$backend~ ^/acs/api/v1/users/(?<uid_path>.*)/permissions$`
Server:	`127.0.0.1:8101`
Backend:	DC/OS Identity and Access Manager (Bouncer)
API Reference:	https://docs.d2iq.com/mesosphere/dcos/2.2/security/ent/iam-api/

Path:	`http://$backend`
Server:	`unix:/run/dcos/dcos-cluster-linker.sock`
Backend:	DC/OS Cluster Linker
API Reference:	https://docs.d2iq.com/mesosphere/dcos/2.2/administering-clusters/multiple-clusters/cluster-link-api/

Regex:	`^/cockroachdb$`
Replacement:	`$scheme://$http_host/cockroachdb/`
Type:	`permanent`

Path:	`https://$backend/`
Server:	`127.0.0.1:8090`
Backend:	CockroachDB
API Reference:	https://www.cockroachlabs.com/

Path:	`http://$backend/lashup/key`
Server:	`127.0.0.1:62080`
Backend:	DC/OS Net

Path:	`http://$backend/`
Server:	`127.0.0.1:8181`
Backend:	Exhibitor (Zookeeper)
API Reference:	https://github.com/soabase/exhibitor/wiki/REST-Introduction

Admin Router running on DC/OS master nodes

File /

Proxy /(slave|agent)/(?<agentid>[0-9a-zA-Z-]+)(?<url>.+)

File /acs/acl-schema.json

Proxy /acs/api/v1

Proxy /acs/api/v1/auth/(login|logout|jwks|providers|oidc/callback|oidc/providers/?|saml/providers/?)

Proxy /acs/api/v1/auth/saml/providers/[0-9a-zA-Z-]+/acs-callback

Proxy /acs/api/v1/users/(?<uid_path>.*)/permissions

Proxy /internal/acs/api/v1/

Proxy /capabilities

Proxy /ca/api/v2/(newcert|newkey|sign)

Proxy /ca/api/v2/bundle

Proxy /ca/api/v2/info

File /ca/cacerts.jks

File /ca/dcos-ca.crt

Proxy /cluster/

Redirect /cockroachdb

Proxy /cockroachdb/

Proxy /cosmos/service/

Proxy /navstar/lashup/key

Proxy /exhibitor/

Proxy /exhibitor/exhibitor/v1/cluster/status

Rewrite /marathon/

Proxy /mesos/

Proxy /mesos_dns/

File /dcos-metadata/bootstrap-config.json

File /dcos-metadata/dcos-version.json

File /dcos-metadata/ui-config.json

Lua /metadata

Proxy /net/v1/nodes

Proxy /networking/api/v1/

Proxy /internal/mesos_dns/

Proxy /package/

Proxy /pkgpanda/

File /pkgpanda/active.buildinfo.full.json

Proxy /secrets/v1/

Proxy /service/(?<service_path>.+)

Proxy /system/health/v1

Proxy /system/v1/agent/(?<agentid>[0-9a-zA-Z-]+)(?<url>/logs.*|/metrics/v0.*|/dcos-metadata/dcos-version.json)

Proxy /system/v1/backup/

Proxy /system/v1/leader/marathon(?<url>.*)

Proxy /system/v1/leader/mesos(?<url>.*)

Proxy /system/v1/logs/

Proxy /system/v1/metrics/

File `/`

Proxy `/(slave|agent)/(?<agentid>[0-9a-zA-Z-]+)(?<url>.+)`

File `/acs/acl-schema.json`

Proxy `/acs/api/v1`

Proxy `/acs/api/v1/auth/(login|logout|jwks|providers|oidc/callback|oidc/providers/?|saml/providers/?)`

Proxy `/acs/api/v1/auth/saml/providers/[0-9a-zA-Z-]+/acs-callback`

Proxy `/acs/api/v1/users/(?<uid_path>.*)/permissions`

Proxy `/internal/acs/api/v1/`

Proxy `/capabilities`

Proxy `/ca/api/v2/(newcert|newkey|sign)`

Proxy `/ca/api/v2/bundle`

Proxy `/ca/api/v2/info`

File `/ca/cacerts.jks`

File `/ca/dcos-ca.crt`

Proxy `/cluster/`

Redirect `/cockroachdb`

Proxy `/cockroachdb/`

Proxy `/cosmos/service/`

Proxy `/navstar/lashup/key`

Proxy `/exhibitor/`

Proxy `/exhibitor/exhibitor/v1/cluster/status`

Rewrite `/marathon/`

Proxy `/mesos/`

Proxy `/mesos_dns/`

File `/dcos-metadata/bootstrap-config.json`

File `/dcos-metadata/dcos-version.json`

File `/dcos-metadata/ui-config.json`

Lua `/metadata`

Proxy `/net/v1/nodes`

Proxy `/networking/api/v1/`

Proxy `/internal/mesos_dns/`

Proxy `/package/`

Proxy `/pkgpanda/`

File `/pkgpanda/active.buildinfo.full.json`

Proxy `/secrets/v1/`

Proxy `/service/(?<service_path>.+)`

Proxy `/system/health/v1`

Proxy `/system/v1/agent/(?<agentid>[0-9a-zA-Z-]+)(?<url>/logs.|/metrics/v0.|/dcos-metadata/dcos-version.json)`

Proxy `/system/v1/backup/`

Proxy `/system/v1/leader/marathon(?<url>.*)`

Proxy `/system/v1/leader/mesos(?<url>.*)`

Proxy `/system/v1/logs/`

Proxy `/system/v1/metrics/`