mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
100 lines
3.6 KiB
ReStructuredText
100 lines
3.6 KiB
ReStructuredText
:title: Remote API
|
|
:description: API Documentation for Docker
|
|
:keywords: API, Docker, rcli, REST, documentation
|
|
|
|
=================
|
|
Docker Remote API
|
|
=================
|
|
|
|
.. contents:: 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.2
|
|
Calling /images/<name>/insert is the same as calling /v1.2/images/<name>/insert
|
|
You can still call an old version of the api using /v1.0/images/<name>/insert
|
|
|
|
:doc:`docker_remote_api_v1.2`
|
|
*****************************
|
|
|
|
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
|
|
|
|
.. http:get:: /auth is now deprecated
|
|
.. http: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 chidrens and remove all the untagged parents if has any.
|
|
.. http:post:: /images/<name>/delete now returns a JSON with the list of images deleted/untagged
|
|
|
|
|
|
:doc:`docker_remote_api_v1.1`
|
|
*****************************
|
|
|
|
docker v0.4.0 a8ae398_
|
|
|
|
What's new
|
|
----------
|
|
|
|
.. http:post:: /images/create
|
|
.. http:post:: /images/(name)/insert
|
|
.. http:post:: /images/(name)/push
|
|
|
|
Uses json stream instead of HTML hijack, it looks like this:
|
|
|
|
.. sourcecode:: http
|
|
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json
|
|
|
|
{"status":"Pushing..."}
|
|
{"status":"Pushing", "progress":"1/? (n/a)"}
|
|
{"error":"Invalid..."}
|
|
...
|
|
|
|
|
|
docker v0.3.4 8d73740_
|
|
|
|
What's new
|
|
----------
|
|
|
|
Initial version
|
|
|
|
|
|
.. _a8ae398: https://github.com/dotcloud/docker/commit/a8ae398bf52e97148ee7bd0d5868de2e15bd297f
|
|
.. _8d73740: https://github.com/dotcloud/docker/commit/8d73740343778651c09160cde9661f5f387b36f4
|
|
|
|
==================================
|
|
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 |
|
|
+----------------------+----------------+--------------------------------------------+
|
|
| Javascript | docker-js | https://github.com/dgoujard/docker-js |
|
|
+----------------------+----------------+--------------------------------------------+
|
|
| Javascript (Angular) | dockerui | https://github.com/crosbymichael/dockerui |
|
|
| **WebUI** | | |
|
|
+----------------------+----------------+--------------------------------------------+
|