mirror of https://github.com/docker/docs.git
Fix merge issue
This commit is contained in:
Guillaume J. Charmes
parent
555552340d
commit
6e17cc45ea
|
|
@ -66,285 +66,8 @@ Uses json stream instead of HTML hijack, it looks like this:
|
||||||
|
|
||||||
docker v0.3.4 8d73740_
|
docker v0.3.4 8d73740_
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
What's new
|
||||||
Content-Type: application/vnd.docker.raw-stream
|
----------
|
||||||
|
|
||||||
{{ STREAM }}
|
|
||||||
|
|
||||||
:query registry: the registry you wan to push, optional
|
|
||||||
:statuscode 200: no error
|
|
||||||
:statuscode 404: no such image
|
|
||||||
:statuscode 500: server error
|
|
||||||
|
|
||||||
|
|
||||||
Tag an image into a repository
|
|
||||||
******************************
|
|
||||||
|
|
||||||
.. http:post:: /images/(name)/tag
|
|
||||||
|
|
||||||
Tag the image ``name`` into a repository
|
|
||||||
|
|
||||||
**Example request**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1
|
|
||||||
|
|
||||||
**Example response**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
|
||||||
|
|
||||||
:query repo: The repository to tag in
|
|
||||||
:query force: 1/True/true or 0/False/false, default false
|
|
||||||
:statuscode 200: no error
|
|
||||||
:statuscode 400: bad parameter
|
|
||||||
:statuscode 404: no such image
|
|
||||||
:statuscode 500: server error
|
|
||||||
|
|
||||||
|
|
||||||
Remove an image
|
|
||||||
***************
|
|
||||||
|
|
||||||
.. http:delete:: /images/(name)
|
|
||||||
|
|
||||||
Remove the image ``name`` from the filesystem
|
|
||||||
|
|
||||||
**Example request**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
DELETE /images/test HTTP/1.1
|
|
||||||
|
|
||||||
**Example response**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
HTTP/1.1 204 OK
|
|
||||||
|
|
||||||
:statuscode 204: no error
|
|
||||||
:statuscode 404: no such image
|
|
||||||
:statuscode 500: server error
|
|
||||||
|
|
||||||
|
|
||||||
Search images
|
|
||||||
*************
|
|
||||||
|
|
||||||
.. http:get:: /images/search
|
|
||||||
|
|
||||||
Search for an image in the docker index
|
|
||||||
|
|
||||||
**Example request**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
GET /images/search?term=sshd HTTP/1.1
|
|
||||||
|
|
||||||
**Example response**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"Name":"cespare/sshd",
|
|
||||||
"Description":""
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"Name":"johnfuller/sshd",
|
|
||||||
"Description":""
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"Name":"dhrp/mongodb-sshd",
|
|
||||||
"Description":""
|
|
||||||
}
|
|
||||||
]
|
|
||||||
|
|
||||||
:query term: term to search
|
|
||||||
:statuscode 200: no error
|
|
||||||
:statuscode 500: server error
|
|
||||||
|
|
||||||
|
|
||||||
3.3 Misc
|
|
||||||
--------
|
|
||||||
|
|
||||||
Build an image from Dockerfile via stdin
|
|
||||||
****************************************
|
|
||||||
|
|
||||||
.. http:post:: /build
|
|
||||||
|
|
||||||
Build an image from Dockerfile via stdin
|
|
||||||
|
|
||||||
**Example request**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
POST /build HTTP/1.1
|
|
||||||
|
|
||||||
{{ STREAM }}
|
|
||||||
|
|
||||||
**Example response**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
|
||||||
|
|
||||||
{{ STREAM }}
|
|
||||||
|
|
||||||
:query t: tag to be applied to the resulting image in case of success
|
|
||||||
:query remote: URL to be fetch. Either a single Dockerfile or a Git repository
|
|
||||||
:statuscode 200: no error
|
|
||||||
:statuscode 500: server error
|
|
||||||
|
|
||||||
|
|
||||||
Get default username and email
|
|
||||||
******************************
|
|
||||||
|
|
||||||
.. http:get:: /auth
|
|
||||||
|
|
||||||
Get the default username and email
|
|
||||||
|
|
||||||
**Example request**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
GET /auth HTTP/1.1
|
|
||||||
|
|
||||||
**Example response**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
{
|
|
||||||
"username":"hannibal",
|
|
||||||
"email":"hannibal@a-team.com"
|
|
||||||
}
|
|
||||||
|
|
||||||
:statuscode 200: no error
|
|
||||||
:statuscode 500: server error
|
|
||||||
|
|
||||||
|
|
||||||
Set auth configuration
|
|
||||||
**********************
|
|
||||||
|
|
||||||
.. http:post:: /auth
|
|
||||||
|
|
||||||
Get the default username and email
|
|
||||||
|
|
||||||
**Example request**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
POST /auth HTTP/1.1
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
{
|
|
||||||
"username":"hannibal",
|
|
||||||
"password:"xxxx",
|
|
||||||
"email":"hannibal@a-team.com"
|
|
||||||
}
|
|
||||||
|
|
||||||
**Example response**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
|
||||||
|
|
||||||
:statuscode 200: no error
|
|
||||||
:statuscode 204: no error
|
|
||||||
:statuscode 500: server error
|
|
||||||
|
|
||||||
|
|
||||||
Display system-wide information
|
|
||||||
*******************************
|
|
||||||
|
|
||||||
.. http:get:: /info
|
|
||||||
|
|
||||||
Display system-wide information
|
|
||||||
|
|
||||||
**Example request**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
GET /info HTTP/1.1
|
|
||||||
|
|
||||||
**Example response**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
{
|
|
||||||
"Containers":11,
|
|
||||||
"Images":16,
|
|
||||||
"Debug":false,
|
|
||||||
"NFd": 11,
|
|
||||||
"NGoroutines":21,
|
|
||||||
"MemoryLimit":true,
|
|
||||||
"SwapLimit":false
|
|
||||||
}
|
|
||||||
|
|
||||||
:statuscode 200: no error
|
|
||||||
:statuscode 500: server error
|
|
||||||
|
|
||||||
|
|
||||||
Show the docker version information
|
|
||||||
***********************************
|
|
||||||
|
|
||||||
.. http:get:: /version
|
|
||||||
|
|
||||||
Show the docker version information
|
|
||||||
|
|
||||||
**Example request**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
GET /version HTTP/1.1
|
|
||||||
|
|
||||||
**Example response**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
|
||||||
Content-Type: application/json
|
|
||||||
|
|
||||||
{
|
|
||||||
"Version":"0.2.2",
|
|
||||||
"GitCommit":"5a2a5cc+CHANGES",
|
|
||||||
"GoVersion":"go1.0.3"
|
|
||||||
}
|
|
||||||
|
|
||||||
:statuscode 200: no error
|
|
||||||
:statuscode 500: server error
|
|
||||||
|
|
||||||
|
|
||||||
Create a new image from a container's changes
|
|
||||||
*********************************************
|
|
||||||
|
|
||||||
.. http:post:: /commit
|
|
||||||
|
|
||||||
Create a new image from a container's changes
|
|
||||||
|
|
||||||
**Example request**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
|
|
||||||
|
|
||||||
**Example response**:
|
|
||||||
|
|
||||||
.. sourcecode:: http
|
|
||||||
|
|
||||||
HTTP/1.1 201 OK
|
|
||||||
Content-Type: application/vnd.docker.raw-stream
|
|
||||||
|
|
||||||
{"Id":"596069db4bf5"}
|
|
||||||
|
|
||||||
Initial version
|
Initial version
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue