| ... | ... |
@@ -66,285 +66,8 @@ Uses json stream instead of HTML hijack, it looks like this: |
| 66 | 66 |
|
| 67 | 67 |
docker v0.3.4 8d73740_ |
| 68 | 68 |
|
| 69 |
- HTTP/1.1 200 OK |
|
| 70 |
- Content-Type: application/vnd.docker.raw-stream |
|
| 71 |
- |
|
| 72 |
- {{ STREAM }}
|
|
| 73 |
- |
|
| 74 |
- :query registry: the registry you wan to push, optional |
|
| 75 |
- :statuscode 200: no error |
|
| 76 |
- :statuscode 404: no such image |
|
| 77 |
- :statuscode 500: server error |
|
| 78 |
- |
|
| 79 |
- |
|
| 80 |
-Tag an image into a repository |
|
| 81 |
-****************************** |
|
| 82 |
- |
|
| 83 |
-.. http:post:: /images/(name)/tag |
|
| 84 |
- |
|
| 85 |
- Tag the image ``name`` into a repository |
|
| 86 |
- |
|
| 87 |
- **Example request**: |
|
| 88 |
- |
|
| 89 |
- .. sourcecode:: http |
|
| 90 |
- |
|
| 91 |
- POST /images/test/tag?repo=myrepo&force=0 HTTP/1.1 |
|
| 92 |
- |
|
| 93 |
- **Example response**: |
|
| 94 |
- |
|
| 95 |
- .. sourcecode:: http |
|
| 96 |
- |
|
| 97 |
- HTTP/1.1 200 OK |
|
| 98 |
- |
|
| 99 |
- :query repo: The repository to tag in |
|
| 100 |
- :query force: 1/True/true or 0/False/false, default false |
|
| 101 |
- :statuscode 200: no error |
|
| 102 |
- :statuscode 400: bad parameter |
|
| 103 |
- :statuscode 404: no such image |
|
| 104 |
- :statuscode 500: server error |
|
| 105 |
- |
|
| 106 |
- |
|
| 107 |
-Remove an image |
|
| 108 |
-*************** |
|
| 109 |
- |
|
| 110 |
-.. http:delete:: /images/(name) |
|
| 111 |
- |
|
| 112 |
- Remove the image ``name`` from the filesystem |
|
| 113 |
- |
|
| 114 |
- **Example request**: |
|
| 115 |
- |
|
| 116 |
- .. sourcecode:: http |
|
| 117 |
- |
|
| 118 |
- DELETE /images/test HTTP/1.1 |
|
| 119 |
- |
|
| 120 |
- **Example response**: |
|
| 121 |
- |
|
| 122 |
- .. sourcecode:: http |
|
| 123 |
- |
|
| 124 |
- HTTP/1.1 204 OK |
|
| 125 |
- |
|
| 126 |
- :statuscode 204: no error |
|
| 127 |
- :statuscode 404: no such image |
|
| 128 |
- :statuscode 500: server error |
|
| 129 |
- |
|
| 130 |
- |
|
| 131 |
-Search images |
|
| 132 |
-************* |
|
| 133 |
- |
|
| 134 |
-.. http:get:: /images/search |
|
| 135 |
- |
|
| 136 |
- Search for an image in the docker index |
|
| 137 |
- |
|
| 138 |
- **Example request**: |
|
| 139 |
- |
|
| 140 |
- .. sourcecode:: http |
|
| 141 |
- |
|
| 142 |
- GET /images/search?term=sshd HTTP/1.1 |
|
| 143 |
- |
|
| 144 |
- **Example response**: |
|
| 145 |
- |
|
| 146 |
- .. sourcecode:: http |
|
| 147 |
- |
|
| 148 |
- HTTP/1.1 200 OK |
|
| 149 |
- Content-Type: application/json |
|
| 150 |
- |
|
| 151 |
- [ |
|
| 152 |
- {
|
|
| 153 |
- "Name":"cespare/sshd", |
|
| 154 |
- "Description":"" |
|
| 155 |
- }, |
|
| 156 |
- {
|
|
| 157 |
- "Name":"johnfuller/sshd", |
|
| 158 |
- "Description":"" |
|
| 159 |
- }, |
|
| 160 |
- {
|
|
| 161 |
- "Name":"dhrp/mongodb-sshd", |
|
| 162 |
- "Description":"" |
|
| 163 |
- } |
|
| 164 |
- ] |
|
| 165 |
- |
|
| 166 |
- :query term: term to search |
|
| 167 |
- :statuscode 200: no error |
|
| 168 |
- :statuscode 500: server error |
|
| 169 |
- |
|
| 170 |
- |
|
| 171 |
-3.3 Misc |
|
| 172 |
- |
|
| 173 |
-Build an image from Dockerfile via stdin |
|
| 174 |
-**************************************** |
|
| 175 |
- |
|
| 176 |
-.. http:post:: /build |
|
| 177 |
- |
|
| 178 |
- Build an image from Dockerfile via stdin |
|
| 179 |
- |
|
| 180 |
- **Example request**: |
|
| 181 |
- |
|
| 182 |
- .. sourcecode:: http |
|
| 183 |
- |
|
| 184 |
- POST /build HTTP/1.1 |
|
| 185 |
- |
|
| 186 |
- {{ STREAM }}
|
|
| 187 |
- |
|
| 188 |
- **Example response**: |
|
| 189 |
- |
|
| 190 |
- .. sourcecode:: http |
|
| 191 |
- |
|
| 192 |
- HTTP/1.1 200 OK |
|
| 193 |
- |
|
| 194 |
- {{ STREAM }}
|
|
| 195 |
- |
|
| 196 |
- :query t: tag to be applied to the resulting image in case of success |
|
| 197 |
- :query remote: URL to be fetch. Either a single Dockerfile or a Git repository |
|
| 198 |
- :statuscode 200: no error |
|
| 199 |
- :statuscode 500: server error |
|
| 200 |
- |
|
| 201 |
- |
|
| 202 |
-Get default username and email |
|
| 203 |
-****************************** |
|
| 204 |
- |
|
| 205 |
-.. http:get:: /auth |
|
| 206 |
- |
|
| 207 |
- Get the default username and email |
|
| 208 |
- |
|
| 209 |
- **Example request**: |
|
| 210 |
- |
|
| 211 |
- .. sourcecode:: http |
|
| 212 |
- |
|
| 213 |
- GET /auth HTTP/1.1 |
|
| 214 |
- |
|
| 215 |
- **Example response**: |
|
| 216 |
- |
|
| 217 |
- .. sourcecode:: http |
|
| 218 |
- |
|
| 219 |
- HTTP/1.1 200 OK |
|
| 220 |
- Content-Type: application/json |
|
| 221 |
- |
|
| 222 |
- {
|
|
| 223 |
- "username":"hannibal", |
|
| 224 |
- "email":"hannibal@a-team.com" |
|
| 225 |
- } |
|
| 226 |
- |
|
| 227 |
- :statuscode 200: no error |
|
| 228 |
- :statuscode 500: server error |
|
| 229 |
- |
|
| 230 |
- |
|
| 231 |
-Set auth configuration |
|
| 232 |
-********************** |
|
| 233 |
- |
|
| 234 |
-.. http:post:: /auth |
|
| 235 |
- |
|
| 236 |
- Get the default username and email |
|
| 237 |
- |
|
| 238 |
- **Example request**: |
|
| 239 |
- |
|
| 240 |
- .. sourcecode:: http |
|
| 241 |
- |
|
| 242 |
- POST /auth HTTP/1.1 |
|
| 243 |
- Content-Type: application/json |
|
| 244 |
- |
|
| 245 |
- {
|
|
| 246 |
- "username":"hannibal", |
|
| 247 |
- "password:"xxxx", |
|
| 248 |
- "email":"hannibal@a-team.com" |
|
| 249 |
- } |
|
| 250 |
- |
|
| 251 |
- **Example response**: |
|
| 252 |
- |
|
| 253 |
- .. sourcecode:: http |
|
| 254 |
- |
|
| 255 |
- HTTP/1.1 200 OK |
|
| 256 |
- |
|
| 257 |
- :statuscode 200: no error |
|
| 258 |
- :statuscode 204: no error |
|
| 259 |
- :statuscode 500: server error |
|
| 260 |
- |
|
| 261 |
- |
|
| 262 |
-Display system-wide information |
|
| 263 |
-******************************* |
|
| 264 |
- |
|
| 265 |
-.. http:get:: /info |
|
| 266 |
- |
|
| 267 |
- Display system-wide information |
|
| 268 |
- |
|
| 269 |
- **Example request**: |
|
| 270 |
- |
|
| 271 |
- .. sourcecode:: http |
|
| 272 |
- |
|
| 273 |
- GET /info HTTP/1.1 |
|
| 274 |
- |
|
| 275 |
- **Example response**: |
|
| 276 |
- |
|
| 277 |
- .. sourcecode:: http |
|
| 278 |
- |
|
| 279 |
- HTTP/1.1 200 OK |
|
| 280 |
- Content-Type: application/json |
|
| 281 |
- |
|
| 282 |
- {
|
|
| 283 |
- "Containers":11, |
|
| 284 |
- "Images":16, |
|
| 285 |
- "Debug":false, |
|
| 286 |
- "NFd": 11, |
|
| 287 |
- "NGoroutines":21, |
|
| 288 |
- "MemoryLimit":true, |
|
| 289 |
- "SwapLimit":false |
|
| 290 |
- } |
|
| 291 |
- |
|
| 292 |
- :statuscode 200: no error |
|
| 293 |
- :statuscode 500: server error |
|
| 294 |
- |
|
| 295 |
- |
|
| 296 |
-Show the docker version information |
|
| 297 |
-*********************************** |
|
| 298 |
- |
|
| 299 |
-.. http:get:: /version |
|
| 300 |
- |
|
| 301 |
- Show the docker version information |
|
| 302 |
- |
|
| 303 |
- **Example request**: |
|
| 304 |
- |
|
| 305 |
- .. sourcecode:: http |
|
| 306 |
- |
|
| 307 |
- GET /version HTTP/1.1 |
|
| 308 |
- |
|
| 309 |
- **Example response**: |
|
| 310 |
- |
|
| 311 |
- .. sourcecode:: http |
|
| 312 |
- |
|
| 313 |
- HTTP/1.1 200 OK |
|
| 314 |
- Content-Type: application/json |
|
| 315 |
- |
|
| 316 |
- {
|
|
| 317 |
- "Version":"0.2.2", |
|
| 318 |
- "GitCommit":"5a2a5cc+CHANGES", |
|
| 319 |
- "GoVersion":"go1.0.3" |
|
| 320 |
- } |
|
| 321 |
- |
|
| 322 |
- :statuscode 200: no error |
|
| 323 |
- :statuscode 500: server error |
|
| 324 |
- |
|
| 325 |
- |
|
| 326 |
-Create a new image from a container's changes |
|
| 327 |
-********************************************* |
|
| 328 |
- |
|
| 329 |
-.. http:post:: /commit |
|
| 330 |
- |
|
| 331 |
- Create a new image from a container's changes |
|
| 332 |
- |
|
| 333 |
- **Example request**: |
|
| 334 |
- |
|
| 335 |
- .. sourcecode:: http |
|
| 336 |
- |
|
| 337 |
- POST /commit?container=44c004db4b17&m=message&repo=myrepo HTTP/1.1 |
|
| 338 |
- |
|
| 339 |
- **Example response**: |
|
| 340 |
- |
|
| 341 |
- .. sourcecode:: http |
|
| 342 |
- |
|
| 343 |
- HTTP/1.1 201 OK |
|
| 344 |
- Content-Type: application/vnd.docker.raw-stream |
|
| 345 |
- |
|
| 346 |
- {"Id":"596069db4bf5"}
|
|
| 69 |
+What's new |
|
| 70 |
+---------- |
|
| 347 | 71 |
|
| 348 | 72 |
Initial version |
| 349 | 73 |
|