docs/api
Victor Vieux 328b9ae13b add support for docker ps -l / -n
Signed-off-by: Victor Vieux <vieux@docker.com>
2015-03-10 01:04:27 +00:00
..
README.md Clarify API documentation 2015-03-09 10:29:02 +00:00
api.go add support for docker ps -l / -n 2015-03-10 01:04:27 +00:00
api_test.go cluster API instead of scheduler API 2015-02-27 14:20:37 -08:00
events.go add Node back to inspect 2015-03-06 16:40:55 -08:00
events_test.go add Node back to inspect 2015-03-06 16:40:55 -08:00
flusher.go add docker stats support 2015-01-21 23:28:41 +00:00
server.go remove events from the cluster interface 2015-02-27 14:20:37 -08:00
server_unix.go separate unix-related codes to make Swarm buildable on Windows 2014-12-30 11:25:49 +07:00
server_windows.go separate unix-related codes to make Swarm buildable on Windows 2014-12-30 11:25:49 +07:00
sorter.go replace 0.0.0.0 by node IP 2014-11-13 02:42:13 +00:00
utils.go remove proxyContainerAndForceRefresh 2015-03-02 17:11:09 -08:00

README.md

page_title page_description page_keywords
Docker Swarm API Swarm API 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.

Missing endpoints

Some endpoints have not yet been implemented and will return a 404 error.

GET "/images/get"
GET "/containers/{name:.*}/attach/ws"

POST "/commit"
POST "/build"
POST "/images/create" (pull implemented)
POST "/images/load"
POST "/images/{name:.*}/push"
POST "/images/{name:.*}/tag"

DELETE "/images/{name:.*}"

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.

Docker Swarm documentation index