docker_remote_api_v1.3.rst 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086
  1. :title: Remote API v1.3
  2. :description: API Documentation for Docker
  3. :keywords: API, Docker, rcli, REST, documentation
  4. ======================
  5. Docker Remote API v1.3
  6. ======================
  7. .. contents:: Table of Contents
  8. 1. Brief introduction
  9. =====================
  10. - The Remote API is replacing rcli
  11. - Default port in the docker deamon is 4243
  12. - 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
  13. 2. Endpoints
  14. ============
  15. 2.1 Containers
  16. --------------
  17. List containers
  18. ***************
  19. .. http:get:: /containers/json
  20. List containers
  21. **Example request**:
  22. .. sourcecode:: http
  23. GET /containers/json?all=1&before=8dfafdbc3a40&size=1 HTTP/1.1
  24. **Example response**:
  25. .. sourcecode:: http
  26. HTTP/1.1 200 OK
  27. Content-Type: application/json
  28. [
  29. {
  30. "Id": "8dfafdbc3a40",
  31. "Image": "base:latest",
  32. "Command": "echo 1",
  33. "Created": 1367854155,
  34. "Status": "Exit 0",
  35. "Ports":"",
  36. "SizeRw":12288,
  37. "SizeRootFs":0
  38. },
  39. {
  40. "Id": "9cd87474be90",
  41. "Image": "base:latest",
  42. "Command": "echo 222222",
  43. "Created": 1367854155,
  44. "Status": "Exit 0",
  45. "Ports":"",
  46. "SizeRw":12288,
  47. "SizeRootFs":0
  48. },
  49. {
  50. "Id": "3176a2479c92",
  51. "Image": "base:latest",
  52. "Command": "echo 3333333333333333",
  53. "Created": 1367854154,
  54. "Status": "Exit 0",
  55. "Ports":"",
  56. "SizeRw":12288,
  57. "SizeRootFs":0
  58. },
  59. {
  60. "Id": "4cb07b47f9fb",
  61. "Image": "base:latest",
  62. "Command": "echo 444444444444444444444444444444444",
  63. "Created": 1367854152,
  64. "Status": "Exit 0",
  65. "Ports":"",
  66. "SizeRw":12288,
  67. "SizeRootFs":0
  68. }
  69. ]
  70. :query all: 1/True/true or 0/False/false, Show all containers. Only running containers are shown by default
  71. :query limit: Show ``limit`` last created containers, include non-running ones.
  72. :query since: Show only containers created since Id, include non-running ones.
  73. :query before: Show only containers created before Id, include non-running ones.
  74. :query size: 1/True/true or 0/False/false, Show the containers sizes
  75. :statuscode 200: no error
  76. :statuscode 400: bad parameter
  77. :statuscode 500: server error
  78. Create a container
  79. ******************
  80. .. http:post:: /containers/create
  81. Create a container
  82. **Example request**:
  83. .. sourcecode:: http
  84. POST /containers/create HTTP/1.1
  85. Content-Type: application/json
  86. {
  87. "Hostname":"",
  88. "User":"",
  89. "Memory":0,
  90. "MemorySwap":0,
  91. "AttachStdin":false,
  92. "AttachStdout":true,
  93. "AttachStderr":true,
  94. "PortSpecs":null,
  95. "Tty":false,
  96. "OpenStdin":false,
  97. "StdinOnce":false,
  98. "Env":null,
  99. "Cmd":[
  100. "date"
  101. ],
  102. "Dns":null,
  103. "Image":"base",
  104. "Volumes":{},
  105. "VolumesFrom":""
  106. }
  107. **Example response**:
  108. .. sourcecode:: http
  109. HTTP/1.1 201 OK
  110. Content-Type: application/json
  111. {
  112. "Id":"e90e34656806"
  113. "Warnings":[]
  114. }
  115. :jsonparam config: the container's configuration
  116. :statuscode 201: no error
  117. :statuscode 404: no such container
  118. :statuscode 406: impossible to attach (container not running)
  119. :statuscode 500: server error
  120. Inspect a container
  121. *******************
  122. .. http:get:: /containers/(id)/json
  123. Return low-level information on the container ``id``
  124. **Example request**:
  125. .. sourcecode:: http
  126. GET /containers/4fa6e0f0c678/json HTTP/1.1
  127. **Example response**:
  128. .. sourcecode:: http
  129. HTTP/1.1 200 OK
  130. Content-Type: application/json
  131. {
  132. "Id": "4fa6e0f0c6786287e131c3852c58a2e01cc697a68231826813597e4994f1d6e2",
  133. "Created": "2013-05-07T14:51:42.041847+02:00",
  134. "Path": "date",
  135. "Args": [],
  136. "Config": {
  137. "Hostname": "4fa6e0f0c678",
  138. "User": "",
  139. "Memory": 0,
  140. "MemorySwap": 0,
  141. "AttachStdin": false,
  142. "AttachStdout": true,
  143. "AttachStderr": true,
  144. "PortSpecs": null,
  145. "Tty": false,
  146. "OpenStdin": false,
  147. "StdinOnce": false,
  148. "Env": null,
  149. "Cmd": [
  150. "date"
  151. ],
  152. "Dns": null,
  153. "Image": "base",
  154. "Volumes": {},
  155. "VolumesFrom": ""
  156. },
  157. "State": {
  158. "Running": false,
  159. "Pid": 0,
  160. "ExitCode": 0,
  161. "StartedAt": "2013-05-07T14:51:42.087658+02:01360",
  162. "Ghost": false
  163. },
  164. "Image": "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
  165. "NetworkSettings": {
  166. "IpAddress": "",
  167. "IpPrefixLen": 0,
  168. "Gateway": "",
  169. "Bridge": "",
  170. "PortMapping": null
  171. },
  172. "SysInitPath": "/home/kitty/go/src/github.com/dotcloud/docker/bin/docker",
  173. "ResolvConfPath": "/etc/resolv.conf",
  174. "Volumes": {}
  175. }
  176. :statuscode 200: no error
  177. :statuscode 404: no such container
  178. :statuscode 500: server error
  179. List processes running inside a container
  180. *****************************************
  181. .. http:get:: /containers/(id)/proc
  182. List processes running inside the container ``id``
  183. **Example request**:
  184. .. sourcecode:: http
  185. GET /containers/4fa6e0f0c678/proc HTTP/1.1
  186. **Example response**:
  187. .. sourcecode:: http
  188. HTTP/1.1 200 OK
  189. Content-Type: application/json
  190. [
  191. {
  192. "PID":"11935",
  193. "Tty":"pts/2",
  194. "Time":"00:00:00",
  195. "Cmd":"sh"
  196. },
  197. {
  198. "PID":"12140",
  199. "Tty":"pts/2",
  200. "Time":"00:00:00",
  201. "Cmd":"sleep"
  202. }
  203. ]
  204. :statuscode 200: no error
  205. :statuscode 404: no such container
  206. :statuscode 500: server error
  207. Inspect changes on a container's filesystem
  208. *******************************************
  209. .. http:get:: /containers/(id)/changes
  210. Inspect changes on container ``id`` 's filesystem
  211. **Example request**:
  212. .. sourcecode:: http
  213. GET /containers/4fa6e0f0c678/changes HTTP/1.1
  214. **Example response**:
  215. .. sourcecode:: http
  216. HTTP/1.1 200 OK
  217. Content-Type: application/json
  218. [
  219. {
  220. "Path":"/dev",
  221. "Kind":0
  222. },
  223. {
  224. "Path":"/dev/kmsg",
  225. "Kind":1
  226. },
  227. {
  228. "Path":"/test",
  229. "Kind":1
  230. }
  231. ]
  232. :statuscode 200: no error
  233. :statuscode 404: no such container
  234. :statuscode 500: server error
  235. Export a container
  236. ******************
  237. .. http:get:: /containers/(id)/export
  238. Export the contents of container ``id``
  239. **Example request**:
  240. .. sourcecode:: http
  241. GET /containers/4fa6e0f0c678/export HTTP/1.1
  242. **Example response**:
  243. .. sourcecode:: http
  244. HTTP/1.1 200 OK
  245. Content-Type: application/octet-stream
  246. {{ STREAM }}
  247. :statuscode 200: no error
  248. :statuscode 404: no such container
  249. :statuscode 500: server error
  250. Start a container
  251. *****************
  252. .. http:post:: /containers/(id)/start
  253. Start the container ``id``
  254. **Example request**:
  255. .. sourcecode:: http
  256. POST /containers/(id)/start HTTP/1.1
  257. Content-Type: application/json
  258. {
  259. "Binds":["/tmp:/tmp"]
  260. }
  261. **Example response**:
  262. .. sourcecode:: http
  263. HTTP/1.1 204 No Content
  264. Content-Type: text/plain
  265. :jsonparam hostConfig: the container's host configuration (optional)
  266. :statuscode 200: no error
  267. :statuscode 404: no such container
  268. :statuscode 500: server error
  269. Stop a contaier
  270. ***************
  271. .. http:post:: /containers/(id)/stop
  272. Stop the container ``id``
  273. **Example request**:
  274. .. sourcecode:: http
  275. POST /containers/e90e34656806/stop?t=5 HTTP/1.1
  276. **Example response**:
  277. .. sourcecode:: http
  278. HTTP/1.1 204 OK
  279. :query t: number of seconds to wait before killing the container
  280. :statuscode 204: no error
  281. :statuscode 404: no such container
  282. :statuscode 500: server error
  283. Restart a container
  284. *******************
  285. .. http:post:: /containers/(id)/restart
  286. Restart the container ``id``
  287. **Example request**:
  288. .. sourcecode:: http
  289. POST /containers/e90e34656806/restart?t=5 HTTP/1.1
  290. **Example response**:
  291. .. sourcecode:: http
  292. HTTP/1.1 204 OK
  293. :query t: number of seconds to wait before killing the container
  294. :statuscode 204: no error
  295. :statuscode 404: no such container
  296. :statuscode 500: server error
  297. Kill a container
  298. ****************
  299. .. http:post:: /containers/(id)/kill
  300. Kill the container ``id``
  301. **Example request**:
  302. .. sourcecode:: http
  303. POST /containers/e90e34656806/kill HTTP/1.1
  304. **Example response**:
  305. .. sourcecode:: http
  306. HTTP/1.1 204 OK
  307. :statuscode 204: no error
  308. :statuscode 404: no such container
  309. :statuscode 500: server error
  310. Attach to a container
  311. *********************
  312. .. http:post:: /containers/(id)/attach
  313. Attach to the container ``id``
  314. **Example request**:
  315. .. sourcecode:: http
  316. POST /containers/16253994b7c4/attach?logs=1&stream=0&stdout=1 HTTP/1.1
  317. **Example response**:
  318. .. sourcecode:: http
  319. HTTP/1.1 200 OK
  320. Content-Type: application/vnd.docker.raw-stream
  321. {{ STREAM }}
  322. :query logs: 1/True/true or 0/False/false, return logs. Default false
  323. :query stream: 1/True/true or 0/False/false, return stream. Default false
  324. :query stdin: 1/True/true or 0/False/false, if stream=true, attach to stdin. Default false
  325. :query stdout: 1/True/true or 0/False/false, if logs=true, return stdout log, if stream=true, attach to stdout. Default false
  326. :query stderr: 1/True/true or 0/False/false, if logs=true, return stderr log, if stream=true, attach to stderr. Default false
  327. :statuscode 200: no error
  328. :statuscode 400: bad parameter
  329. :statuscode 404: no such container
  330. :statuscode 500: server error
  331. Wait a container
  332. ****************
  333. .. http:post:: /containers/(id)/wait
  334. Block until container ``id`` stops, then returns the exit code
  335. **Example request**:
  336. .. sourcecode:: http
  337. POST /containers/16253994b7c4/wait HTTP/1.1
  338. **Example response**:
  339. .. sourcecode:: http
  340. HTTP/1.1 200 OK
  341. Content-Type: application/json
  342. {"StatusCode":0}
  343. :statuscode 200: no error
  344. :statuscode 404: no such container
  345. :statuscode 500: server error
  346. Remove a container
  347. *******************
  348. .. http:delete:: /containers/(id)
  349. Remove the container ``id`` from the filesystem
  350. **Example request**:
  351. .. sourcecode:: http
  352. DELETE /containers/16253994b7c4?v=1 HTTP/1.1
  353. **Example response**:
  354. .. sourcecode:: http
  355. HTTP/1.1 204 OK
  356. :query v: 1/True/true or 0/False/false, Remove the volumes associated to the container. Default false
  357. :statuscode 204: no error
  358. :statuscode 400: bad parameter
  359. :statuscode 404: no such container
  360. :statuscode 500: server error
  361. 2.2 Images
  362. ----------
  363. List Images
  364. ***********
  365. .. http:get:: /images/(format)
  366. List images ``format`` could be json or viz (json default)
  367. **Example request**:
  368. .. sourcecode:: http
  369. GET /images/json?all=0 HTTP/1.1
  370. **Example response**:
  371. .. sourcecode:: http
  372. HTTP/1.1 200 OK
  373. Content-Type: application/json
  374. [
  375. {
  376. "Repository":"base",
  377. "Tag":"ubuntu-12.10",
  378. "Id":"b750fe79269d",
  379. "Created":1364102658,
  380. "Size":24653,
  381. "VirtualSize":180116135
  382. },
  383. {
  384. "Repository":"base",
  385. "Tag":"ubuntu-quantal",
  386. "Id":"b750fe79269d",
  387. "Created":1364102658,
  388. "Size":24653,
  389. "VirtualSize":180116135
  390. }
  391. ]
  392. **Example request**:
  393. .. sourcecode:: http
  394. GET /images/viz HTTP/1.1
  395. **Example response**:
  396. .. sourcecode:: http
  397. HTTP/1.1 200 OK
  398. Content-Type: text/plain
  399. digraph docker {
  400. "d82cbacda43a" -> "074be284591f"
  401. "1496068ca813" -> "08306dc45919"
  402. "08306dc45919" -> "0e7893146ac2"
  403. "b750fe79269d" -> "1496068ca813"
  404. base -> "27cf78414709" [style=invis]
  405. "f71189fff3de" -> "9a33b36209ed"
  406. "27cf78414709" -> "b750fe79269d"
  407. "0e7893146ac2" -> "d6434d954665"
  408. "d6434d954665" -> "d82cbacda43a"
  409. base -> "e9aa60c60128" [style=invis]
  410. "074be284591f" -> "f71189fff3de"
  411. "b750fe79269d" [label="b750fe79269d\nbase",shape=box,fillcolor="paleturquoise",style="filled,rounded"];
  412. "e9aa60c60128" [label="e9aa60c60128\nbase2",shape=box,fillcolor="paleturquoise",style="filled,rounded"];
  413. "9a33b36209ed" [label="9a33b36209ed\ntest",shape=box,fillcolor="paleturquoise",style="filled,rounded"];
  414. base [style=invisible]
  415. }
  416. :query all: 1/True/true or 0/False/false, Show all containers. Only running containers are shown by default
  417. :statuscode 200: no error
  418. :statuscode 400: bad parameter
  419. :statuscode 500: server error
  420. Create an image
  421. ***************
  422. .. http:post:: /images/create
  423. Create an image, either by pull it from the registry or by importing it
  424. **Example request**:
  425. .. sourcecode:: http
  426. POST /images/create?fromImage=base HTTP/1.1
  427. **Example response**:
  428. .. sourcecode:: http
  429. HTTP/1.1 200 OK
  430. Content-Type: application/json
  431. {"status":"Pulling..."}
  432. {"status":"Pulling", "progress":"1/? (n/a)"}
  433. {"error":"Invalid..."}
  434. ...
  435. :query fromImage: name of the image to pull
  436. :query fromSrc: source to import, - means stdin
  437. :query repo: repository
  438. :query tag: tag
  439. :query registry: the registry to pull from
  440. :statuscode 200: no error
  441. :statuscode 500: server error
  442. Insert a file in a image
  443. ************************
  444. .. http:post:: /images/(name)/insert
  445. Insert a file from ``url`` in the image ``name`` at ``path``
  446. **Example request**:
  447. .. sourcecode:: http
  448. POST /images/test/insert?path=/usr&url=myurl HTTP/1.1
  449. **Example response**:
  450. .. sourcecode:: http
  451. HTTP/1.1 200 OK
  452. Content-Type: application/json
  453. {"status":"Inserting..."}
  454. {"status":"Inserting", "progress":"1/? (n/a)"}
  455. {"error":"Invalid..."}
  456. ...
  457. :statuscode 200: no error
  458. :statuscode 500: server error
  459. Inspect an image
  460. ****************
  461. .. http:get:: /images/(name)/json
  462. Return low-level information on the image ``name``
  463. **Example request**:
  464. .. sourcecode:: http
  465. GET /images/base/json HTTP/1.1
  466. **Example response**:
  467. .. sourcecode:: http
  468. HTTP/1.1 200 OK
  469. Content-Type: application/json
  470. {
  471. "id":"b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
  472. "parent":"27cf784147099545",
  473. "created":"2013-03-23T22:24:18.818426-07:00",
  474. "container":"3d67245a8d72ecf13f33dffac9f79dcdf70f75acb84d308770391510e0c23ad0",
  475. "container_config":
  476. {
  477. "Hostname":"",
  478. "User":"",
  479. "Memory":0,
  480. "MemorySwap":0,
  481. "AttachStdin":false,
  482. "AttachStdout":false,
  483. "AttachStderr":false,
  484. "PortSpecs":null,
  485. "Tty":true,
  486. "OpenStdin":true,
  487. "StdinOnce":false,
  488. "Env":null,
  489. "Cmd": ["/bin/bash"]
  490. ,"Dns":null,
  491. "Image":"base",
  492. "Volumes":null,
  493. "VolumesFrom":""
  494. },
  495. "Size": 6824592
  496. }
  497. :statuscode 200: no error
  498. :statuscode 404: no such image
  499. :statuscode 500: server error
  500. Get the history of an image
  501. ***************************
  502. .. http:get:: /images/(name)/history
  503. Return the history of the image ``name``
  504. **Example request**:
  505. .. sourcecode:: http
  506. GET /images/base/history HTTP/1.1
  507. **Example response**:
  508. .. sourcecode:: http
  509. HTTP/1.1 200 OK
  510. Content-Type: application/json
  511. [
  512. {
  513. "Id":"b750fe79269d",
  514. "Created":1364102658,
  515. "CreatedBy":"/bin/bash"
  516. },
  517. {
  518. "Id":"27cf78414709",
  519. "Created":1364068391,
  520. "CreatedBy":""
  521. }
  522. ]
  523. :statuscode 200: no error
  524. :statuscode 404: no such image
  525. :statuscode 500: server error
  526. Push an image on the registry
  527. *****************************
  528. .. http:post:: /images/(name)/push
  529. Push the image ``name`` on the registry
  530. **Example request**:
  531. .. sourcecode:: http
  532. POST /images/test/push HTTP/1.1
  533. {{ authConfig }}
  534. **Example response**:
  535. .. sourcecode:: http
  536. HTTP/1.1 200 OK
  537. Content-Type: application/json
  538. {"status":"Pushing..."}
  539. {"status":"Pushing", "progress":"1/? (n/a)"}
  540. {"error":"Invalid..."}
  541. ...
  542. :query registry: the registry you wan to push, optional
  543. :statuscode 200: no error
  544. :statuscode 404: no such image
  545. :statuscode 500: server error
  546. Tag an image into a repository
  547. ******************************
  548. .. http:post:: /images/(name)/tag
  549. Tag the image ``name`` into a repository
  550. **Example request**:
  551. .. sourcecode:: http
  552. POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1
  553. **Example response**:
  554. .. sourcecode:: http
  555. HTTP/1.1 200 OK
  556. :query repo: The repository to tag in
  557. :query force: 1/True/true or 0/False/false, default false
  558. :statuscode 200: no error
  559. :statuscode 400: bad parameter
  560. :statuscode 404: no such image
  561. :statuscode 409: conflict
  562. :statuscode 500: server error
  563. Remove an image
  564. ***************
  565. .. http:delete:: /images/(name)
  566. Remove the image ``name`` from the filesystem
  567. **Example request**:
  568. .. sourcecode:: http
  569. DELETE /images/test HTTP/1.1
  570. **Example response**:
  571. .. sourcecode:: http
  572. HTTP/1.1 200 OK
  573. Content-type: application/json
  574. [
  575. {"Untagged":"3e2f21a89f"},
  576. {"Deleted":"3e2f21a89f"},
  577. {"Deleted":"53b4f83ac9"}
  578. ]
  579. :statuscode 204: no error
  580. :statuscode 404: no such image
  581. :statuscode 409: conflict
  582. :statuscode 500: server error
  583. Search images
  584. *************
  585. .. http:get:: /images/search
  586. Search for an image in the docker index
  587. **Example request**:
  588. .. sourcecode:: http
  589. GET /images/search?term=sshd HTTP/1.1
  590. **Example response**:
  591. .. sourcecode:: http
  592. HTTP/1.1 200 OK
  593. Content-Type: application/json
  594. [
  595. {
  596. "Name":"cespare/sshd",
  597. "Description":""
  598. },
  599. {
  600. "Name":"johnfuller/sshd",
  601. "Description":""
  602. },
  603. {
  604. "Name":"dhrp/mongodb-sshd",
  605. "Description":""
  606. }
  607. ]
  608. :query term: term to search
  609. :statuscode 200: no error
  610. :statuscode 500: server error
  611. 2.3 Misc
  612. --------
  613. Build an image from Dockerfile via stdin
  614. ****************************************
  615. .. http:post:: /build
  616. Build an image from Dockerfile via stdin
  617. **Example request**:
  618. .. sourcecode:: http
  619. POST /build HTTP/1.1
  620. {{ STREAM }}
  621. **Example response**:
  622. .. sourcecode:: http
  623. HTTP/1.1 200 OK
  624. {{ STREAM }}
  625. The stream must be a tar archive compressed with one of the following algorithms:
  626. identity (no compression), gzip, bzip2, xz. The archive must include a file called
  627. `Dockerfile` at its root. It may include any number of other files, which will be
  628. accessible in the build context (See the ADD build command).
  629. The Content-type header should be set to "application/tar".
  630. :query t: tag to be applied to the resulting image in case of success
  631. :statuscode 200: no error
  632. :statuscode 500: server error
  633. Check auth configuration
  634. ************************
  635. .. http:post:: /auth
  636. Get the default username and email
  637. **Example request**:
  638. .. sourcecode:: http
  639. POST /auth HTTP/1.1
  640. Content-Type: application/json
  641. {
  642. "username":"hannibal",
  643. "password:"xxxx",
  644. "email":"hannibal@a-team.com"
  645. }
  646. **Example response**:
  647. .. sourcecode:: http
  648. HTTP/1.1 200 OK
  649. :statuscode 200: no error
  650. :statuscode 204: no error
  651. :statuscode 500: server error
  652. Display system-wide information
  653. *******************************
  654. .. http:get:: /info
  655. Display system-wide information
  656. **Example request**:
  657. .. sourcecode:: http
  658. GET /info HTTP/1.1
  659. **Example response**:
  660. .. sourcecode:: http
  661. HTTP/1.1 200 OK
  662. Content-Type: application/json
  663. {
  664. "Containers":11,
  665. "Images":16,
  666. "Debug":false,
  667. "NFd": 11,
  668. "NGoroutines":21,
  669. "MemoryLimit":true,
  670. "SwapLimit":false
  671. }
  672. :statuscode 200: no error
  673. :statuscode 500: server error
  674. Show the docker version information
  675. ***********************************
  676. .. http:get:: /version
  677. Show the docker version information
  678. **Example request**:
  679. .. sourcecode:: http
  680. GET /version HTTP/1.1
  681. **Example response**:
  682. .. sourcecode:: http
  683. HTTP/1.1 200 OK
  684. Content-Type: application/json
  685. {
  686. "Version":"0.2.2",
  687. "GitCommit":"5a2a5cc+CHANGES",
  688. "GoVersion":"go1.0.3"
  689. }
  690. :statuscode 200: no error
  691. :statuscode 500: server error
  692. Create a new image from a container's changes
  693. *********************************************
  694. .. http:post:: /commit
  695. Create a new image from a container's changes
  696. **Example request**:
  697. .. sourcecode:: http
  698. POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1
  699. **Example response**:
  700. .. sourcecode:: http
  701. HTTP/1.1 201 OK
  702. Content-Type: application/vnd.docker.raw-stream
  703. {"Id":"596069db4bf5"}
  704. :query container: source container
  705. :query repo: repository
  706. :query tag: tag
  707. :query m: commit message
  708. :query author: author (eg. "John Hannibal Smith <hannibal@a-team.com>")
  709. :query run: config automatically applied when the image is run. (ex: {"Cmd": ["cat", "/world"], "PortSpecs":["22"]})
  710. :statuscode 201: no error
  711. :statuscode 404: no such container
  712. :statuscode 500: server error
  713. 3. Going further
  714. ================
  715. 3.1 Inside 'docker run'
  716. -----------------------
  717. Here are the steps of 'docker run' :
  718. * Create the container
  719. * If the status code is 404, it means the image doesn't exists:
  720. * Try to pull it
  721. * Then retry to create the container
  722. * Start the container
  723. * If you are not in detached mode:
  724. * Attach to the container, using logs=1 (to have stdout and stderr from the container's start) and stream=1
  725. * If in detached mode or only stdin is attached:
  726. * Display the container's id
  727. 3.2 Hijacking
  728. -------------
  729. In this version of the API, /attach, uses hijacking to transport stdin, stdout and stderr on the same socket. This might change in the future.
  730. 3.3 CORS Requests
  731. -----------------
  732. To enable cross origin requests to the remote api add the flag "-api-enable-cors" when running docker in daemon mode.
  733. docker -d -H="192.168.1.9:4243" -api-enable-cors