docker_remote_api_v1.5.rst 24 KB

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