cli/components/engine/docs/sources/api/docker_remote_api.rst

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
• Default port in the docker deamon is 4243
• 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 verson of the API is 1.3 Calling /images/<name>/insert is the same as calling /v1.3/images/<name>/insert You can still call an old version of the api using /v1.0/images/<name>/insert

docker_remote_api_v1.3

What's new

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

Note

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

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

Deleting an image is now improved, will only untag the image if it has chidrens and remove all the untagged parents if has any.

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 OK

Content-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 been not 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-ruby	https://github.com/ActiveState/docker-ruby
Ruby	docker-client	https://github.com/geku/docker-client
Ruby	docker-api	https://github.com/swipely/docker-api
Javascript	docker-js	https://github.com/dgoujard/docker-js
Javascript (Angular) WebUI	dockerui	https://github.com/crosbymichael/dockerui