6.8 KiB
- title
- Remote API
- description
- API Documentation for Docker
- keywords
- API, Docker, rcli, REST, documentation
Docker Remote API
Table of Contents
1. Brief introduction
- The Remote API is replacing rcli
- By default the Docker daemon listens on unix:///var/run/docker.sock and the client must have root access to interact with the daemon
- If a group named docker exists on your system, docker will apply ownership of the socket to the group
- The API tends to be REST, but for some complex commands, like attach or pull, the HTTP connection is hijacked to transport stdout stdin and stderr
- Since API version 1.2, the auth configuration is now handled client side, so the client has to send the authConfig as POST in /images/(name)/push
2. Versions
The current version of the API is 1.5
Calling /images/<name>/insert is the same as calling /v1.5/images/<name>/insert
You can still call an old version of the api using /v1.0/images/<name>/insert
docker_remote_api_v1.5
What's new
New! You can now pass registry credentials (via an AuthConfig object) through the X-Registry-Auth header
New! The AuthConfig object now needs to be passed through the X-Registry-Auth header
New! The format of the Ports entry has been changed to a list of dicts each containing PublicPort, PrivatePort and Type describing a port mapping.
docker_remote_api_v1.4
What's new
New! When pulling a repo, all images are now downloaded in parallel.
New! You can now use ps args with docker top, like docker top <container_id> aux
New! Image's name added in the events
docker_remote_api_v1.3
docker v0.5.0 51f6c4a
What's new
List the processes running inside a container.
New! Monitor docker's events via streaming or via polling
Builder (/build):
- Simplify the upload of the build context
- Simply stream a tarball instead of multipart upload with 4 intermediary buffers
- Simpler, less memory usage, less disk usage and faster
Warning
The /build improvements are not reverse-compatible. Pre 1.3 clients will break on /build.
List containers (/containers/json):
- You can use size=1 to get the size of the containers
Start containers (/containers/<id>/start):
- You can now pass host-specific configuration (e.g. bind mounts) in the POST body for start calls
docker_remote_api_v1.2
docker v0.4.2 2e7649b
What's new
The auth configuration is now handled by the client.
The client should send it's authConfig as POST on each call of /images/(name)/push
Deprecated.
Only checks the configuration but doesn't store it on the server
Deleting an image is now improved, will only untag the image if it has children and remove all the untagged parents if has any.
Now returns a JSON structure with the list of images deleted/untagged.
docker_remote_api_v1.1
docker v0.4.0 a8ae398
What's new
Uses json stream instead of HTML hijack, it looks like this:
HTTP/1.1 200 OKContent-Type: application/json
{"status":"Pushing..."} {"status":"Pushing", "progress":"1/? (n/a)"} {"error":"Invalid..."} ...
docker_remote_api_v1.0
docker v0.3.4 8d73740
What's new
Initial version
Docker Remote API Client Libraries
These libraries have not been tested by the Docker Maintainers for compatibility. Please file issues with the library owners. If you find more library implementations, please list them in Docker doc bugs and we will add the libraries here.
| Language/Framework | Name | Repository |
|---|---|---|
| Python | docker-py | https://github.com/dotcloud/docker-py |
| Ruby | docker-client | https://github.com/geku/docker-client |
| Ruby | docker-api | https://github.com/swipely/docker-api |
| Javascript (NodeJS) | docker.io | https://github.com/appersonlabs/docker.io Install via NPM: npm install docker.io |
| Javascript | docker-js | https://github.com/dgoujard/docker-js |
| Javascript (Angular) WebUI | dockerui | https://github.com/crosbymichael/dockerui |
| Java | docker-java | https://github.com/kpelykh/docker-java |
| Erlang | erldocker | https://github.com/proger/erldocker |
| Go | go-dockerclient | https://github.com/fsouza/go-dockerclient |