page_title: Remote API page_description: API Documentation for Docker page_keywords: API, Docker, rcli, REST, documentation
unix:///var/run/docker.sock and the client must have root access to interact with the daemon.--tls, or --tlsverify) as with Boot2Docker 1.3.0, then you need to add extra parameters to curl or wget when making test API requests: curl --insecure --cert ~/.docker/cert.pem --key ~/.docker/key.pem https://boot2docker:2376/images/json or wget --no-check-certificate --certificate=$DOCKER_CERT_PATH/cert.pem --private-key=$DOCKER_CERT_PATH/key.pem https://boot2docker:2376/images/json -O - -qdocker exists on your system, docker will apply ownership of the socket to the group.authConfig as a POST in /images/(name)/push.X-Registry-Auth header, is currently a Base64 encoded (JSON) string with the following structure: {"username": "string", "password": "string", "email": "string", "serveraddress" : "string", "auth": ""}. Notice that auth is to be left empty, serveraddress is a domain/ip without protocol, and that double quotes (instead of single ones) are required.The current version of the API is v1.16
Calling /info is the same as calling /v1.16/info.
You can still call an old version of the API using /v1.15/info.
GET /info
New! info now returns the number of CPUs available on the machine (NCPU), total memory available (MemTotal), a user-friendly name describing the running Docker daemon (Name), a unique ID identifying the daemon (ID), and a list of daemon labels (Labels).
POST /containers/create
New! You can set the new container's MAC address explicitly.
New! Volumes are now initialized when the container is created.
POST /containers/(id)/copy
New! You can now copy data which is contained in a volume.
POST /containers/create
New! It is now possible to set a container's HostConfig when creating a container. Previously this was only available when starting a container.
DELETE /containers/(id)
New! When using force, the container will be immediately killed with SIGKILL.
POST /containers/(id)/start
New! The hostConfig option now accepts the field CapAdd, which specifies a list of capabilities to add, and the field CapDrop, which specifies a list of capabilities to drop.
POST /images/create
New! The fromImage and repo parameters now supports the repo:tag format. Consequently, the tag parameter is now obsolete. Using the new format and the tag parameter at the same time will return an error.
GET /containers/(name)/json
New! The HostConfig.Links field is now filled correctly
New! Sockets parameter added to the /info endpoint listing all the sockets the daemon is configured to listen on.
POST /containers/(name)/start POST /containers/(name)/stop
New! start and stop will now return 304 if the container's status is not modified
POST /commit
New! Added a pause parameter (default true) to pause the container during commit
POST /build
New! Build now has support for the forcerm parameter to always remove containers
GET /containers/(name)/json GET /images/(name)/json
New! All the JSON keys are now in CamelCase
New! Trusted builds are now Automated Builds - is_trusted is now is_automated.
Removed Insert Endpoint The insert endpoint has been removed.
GET /_ping
New! You can now ping the server via the _ping endpoint.
GET /events
New! You can now use the -until parameter to close connection after timestamp.
GET /containers/(id)/logs
This url is preferred method for getting container logs now.
DELETE /images/(name)
New! You can now use the force parameter to force delete of an image, even if it's tagged in multiple repositories. New! You can now use the noprune parameter to prevent the deletion of parent images
DELETE /containers/(id)
New! You can now use the force parameter to force delete a container, even if it is currently running
POST /build
New! This endpoint now takes a serialized ConfigFile which it uses to resolve the proper registry auth credentials for pulling the base image. Clients which previously implemented the version accepting an AuthConfig object must be updated.
POST /build
New! This endpoint now returns build status as json stream. In case of a build error, it returns the exit status of the failed command.
GET /containers/(id)/json
New! This endpoint now returns the host config for the container.
POST /images/create
POST /images/(name)/insert
POST /images/(name)/push
New! progressDetail object was added in the JSON. It's now possible to get the current value and the total of the progress without having to parse the string.
GET /images/json
The format of the json returned from this uri changed. Instead of an entry for each repo/tag on an image, each image is only represented once, with a nested attribute indicating the repo/tags that apply to that image.
Instead of:
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"VirtualSize": 131506275,
"Size": 131506275,
"Created": 1365714795,
"Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c",
"Tag": "12.04",
"Repository": "ubuntu"
},
{
"VirtualSize": 131506275,
"Size": 131506275,
"Created": 1365714795,
"Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c",
"Tag": "latest",
"Repository": "ubuntu"
},
{
"VirtualSize": 131506275,
"Size": 131506275,
"Created": 1365714795,
"Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c",
"Tag": "precise",
"Repository": "ubuntu"
},
{
"VirtualSize": 180116135,
"Size": 24653,
"Created": 1364102658,
"Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
"Tag": "12.10",
"Repository": "ubuntu"
},
{
"VirtualSize": 180116135,
"Size": 24653,
"Created": 1364102658,
"Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
"Tag": "quantal",
"Repository": "ubuntu"
}
]
The returned json looks like this:
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"RepoTags": [
"ubuntu:12.04",
"ubuntu:precise",
"ubuntu:latest"
],
"Id": "8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c",
"Created": 1365714795,
"Size": 131506275,
"VirtualSize": 131506275
},
{
"RepoTags": [
"ubuntu:12.10",
"ubuntu:quantal"
],
"ParentId": "27cf784147099545",
"Id": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
"Created": 1364102658,
"Size": 24653,
"VirtualSize": 180116135
}
]
GET /images/viz
This URI no longer exists. The images --viz output is now generated in the client, using the /images/json data.
POST /containers/(id)/attach
New! You can now split stderr from stdout. This is done by prefixing a header to each transmission. See POST /containers/(id)/attach. The WebSocket attach is unchanged. Note that attach calls on the previous API version didn't change. Stdout and stderr are merged.
POST /images/create
New! You can now pass registry credentials (via an AuthConfig object) through the X-Registry-Auth header
POST /images/(name)/push
New! The AuthConfig object now needs to be passed through the X-Registry-Auth header
GET /containers/json
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.
POST /images/create
New! When pulling a repo, all images are now downloaded in parallel.
GET /containers/(id)/top
New! You can now use ps args with docker top, like docker top <container_id> aux
GET /events
New! Image's name added in the events
docker v0.5.0 51f6c4a
GET /containers/(id)/top
List the processes running inside a container.
GET /events
New! Monitor docker's events via streaming or via polling
Builder (/build):
Warning: The /build improvements are not reverse-compatible. Pre 1.3 clients will break on /build.
List containers (/containers/json):
Start containers (/containers//start):
docker v0.4.2 2e7649b
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
GET /auth
Deprecated.
POST /auth
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.
POST /images/<name>/delete
Now returns a JSON structure with the list of images deleted/untagged.
docker v0.4.0 a8ae398
POST /images/create
POST /images/(name)/insert
POST /images/(name)/push
Uses json stream instead of HTML hijack, it looks like this:
HTTP/1.1 200 OK
Content-Type: application/json
{"status":"Pushing..."}
{"status":"Pushing", "progress":"1/? (n/a)"}
{"error":"Invalid..."}
...
docker v0.3.4 8d73740
Initial version