page_title: Docker Swarm API page_description: Swarm API page_keywords: docker, swarm, clustering, api

Docker Swarm API

The Docker Swarm API is mostly compatible with the Docker Remote API. This document is an overview of the differences between the Swarm API and the Docker Remote API.

Endpoints which behave differently

• GET "/containers/{name:.*}/json": New field Node added:

"Node": {
	"Id": "ODAI:IC6Q:MSBL:TPB5:HIEE:6IKC:VCAM:QRNH:PRGX:ERZT:OK46:PMFX",
	"Ip": "0.0.0.0",
	"Addr": "http://0.0.0.0:4243",
	"Name": "vagrant-ubuntu-saucy-64",
    },

• GET "/containers/{name:.*}/json": HostIP replaced by the the actual Node's IP if HostIP is 0.0.0.0

• GET "/containers/json": Node's name prepended to the container name.

• GET "/containers/json": HostIP replaced by the the actual Node's IP if HostIP is 0.0.0.0

• GET "/containers/json" : Containers started from the swarm official image are hidden by default, use all=1 to display them.

• GET "/images/json" : Use '--filter node=<Node name>' to show images of the specific node.

Docker Swarm documentation index

• User guide
• Discovery options
• Sheduler strategies
• Sheduler filters