docs/api
Xian Chaobo 6306fe3b64 Update README.md
Signed-off-by: Xian Chaobo <xianchaobo@huawei.com>
2015-04-09 10:44:28 +08:00
..
README.md Update README.md 2015-04-09 10:44:28 +08:00
api.go fix node field in docker inspect 2015-04-08 14:09:57 -07:00
api_test.go cluster API instead of scheduler API 2015-02-27 14:20:37 -08:00
events.go transform node interface to engine struct 2015-04-06 13:19:37 -07:00
events_test.go transform node interface to engine struct 2015-04-06 13:19:37 -07:00
flusher.go Improve godocs for exported values in api pkg 2015-03-30 21:32:08 -07:00
server.go Improve godocs for exported values in api pkg 2015-03-30 21:32:08 -07: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 Improve godocs for exported values in api pkg 2015-03-30 21:32:08 -07: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"

POST "/build"
POST "/images/load"
POST "/images/create" : "docker import" flow not implement

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