1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

documentation

This commit is contained in:
Victor Vieux 2013-05-28 15:49:57 +00:00
parent 5a36efb61f
commit 8699805756

View file

@ -15,10 +15,17 @@ Docker Remote API
- Default port in the docker deamon is 4243 - 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 - 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
2. Endpoints 2. Version
==========
The current verson of the API is 1.1
Calling /images/<name>/insert is the same as calling /v1.1/images/<name>/insert
You can still call an old version of the api using /v1.0/images/<name>/insert
3. Endpoints
============ ============
2.1 Containers 3.1 Containers
-------------- --------------
List containers List containers
@ -459,7 +466,7 @@ Remove a container
:statuscode 500: server error :statuscode 500: server error
2.2 Images 3.2 Images
---------- ----------
List Images List Images
@ -548,7 +555,19 @@ Create an image
POST /images/create?fromImage=base HTTP/1.1 POST /images/create?fromImage=base HTTP/1.1
**Example response**: **Example response v1.1**:
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{"status":"Pulling..."}
{"progress":"1/? (n/a)"}
{"error":"Invalid..."}
...
**Example response v1.0**:
.. sourcecode:: http .. sourcecode:: http
@ -579,7 +598,19 @@ Insert a file in a image
POST /images/test/insert?path=/usr&url=myurl HTTP/1.1 POST /images/test/insert?path=/usr&url=myurl HTTP/1.1
**Example response**: **Example response v1.1**:
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{"status":"Inserting..."}
{"progress":"1/? (n/a)"}
{"error":"Invalid..."}
...
**Example response v1.0**:
.. sourcecode:: http .. sourcecode:: http
@ -694,7 +725,19 @@ Push an image on the registry
POST /images/test/push HTTP/1.1 POST /images/test/push HTTP/1.1
**Example response**: **Example response v1.1**:
.. sourcecode:: http
HTTP/1.1 200 OK
Content-Type: application/json
{"status":"Pushing..."}
{"progress":"1/? (n/a)"}
{"error":"Invalid..."}
...
**Example response v1.0**:
.. sourcecode:: http .. sourcecode:: http
@ -800,7 +843,7 @@ Search images
:statuscode 500: server error :statuscode 500: server error
2.3 Misc 3.3 Misc
-------- --------
Build an image from Dockerfile via stdin Build an image from Dockerfile via stdin