docs/api
Victor Vieux 4da6b2b093 Merge pull request #551 from noxiouz/fix_eventsHandler
[eventsHandler] Use Lock/Unlock to sync a write access
2015-05-13 17:58:52 -07:00
..
README.md update api README.md 2015-05-11 21:37:45 -04:00
api_test.go cluster API instead of scheduler API 2015-02-27 14:20:37 -08:00
events.go Merge pull request #551 from noxiouz/fix_eventsHandler 2015-05-13 17:58:52 -07:00
events_test.go Cleanup events handler. 2015-04-15 15:59:55 -07:00
flusher.go Improve godocs for exported values in api pkg 2015-03-30 21:32:08 -07:00
handlers.go APIVersion -> ApiVersion to match docker API 2015-05-13 17:12:16 -07:00
router.go add-support-images-save 2015-05-11 16:44:15 -07:00
server.go Cleanup events handler. 2015-04-15 15:59:55 -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 docker ps: Support for filters and improve state management. 2015-05-06 23:38:32 -07:00
utils.go swarm IDs: Convert Swarm ID to Container ID in API Proxy. 2015-05-11 16:56:08 -07: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.

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