moby/docs/sources/reference/api
David Pelaez 8c2b170c6e Improved X-Registry-Auth content instructions
Hi,

this is a small contribution to fix some slightly unprecise information about the `X-Registry-Auth` header required to pull from private registries through the remote API. After a lot of trial and I error I managed to find that the documentation indications had this issues:

* Apparently single quotes cannot be used and double quotes (regular JSON) is required.
* Also the `auth` key must be passed even if empty or a 403 will result.
* It was not clear what the `serveraddress` had to be.

I added some small clarifications for anyone taking a look at the docs to keep them from the problems I've encountered. Hope this is helpful.

Thanks to all the contributors for bringing so much awesomeness to the linux world. :)

Signed-off-by: David Pelaez Tamayo <hello@davidpelaez.me>
2014-09-16 19:20:47 -05:00
..
_static Updated OAuth docs per arothfusz's comments 2014-02-27 14:21:24 -08:00
docker-io_api.md Reformat the API docs so I can read them 2014-09-09 16:17:38 +10:00
docker_io_accounts_api.md Reformat the API docs so I can read them 2014-09-09 16:17:38 +10:00
docker_remote_api.md Improved X-Registry-Auth content instructions 2014-09-16 19:20:47 -05:00
docker_remote_api_v1.0.md Reformat the API docs so I can read them 2014-09-09 16:17:38 +10:00
docker_remote_api_v1.1.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.2.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.3.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.4.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.5.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.6.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.7.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.8.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.9.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.10.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.11.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.12.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.13.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.14.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
docker_remote_api_v1.15.md docs/reference/api: fix typo in docs 2014-09-12 13:57:43 -03:00
hub_registry_spec.md Reformat the API docs so I can read them 2014-09-09 16:17:38 +10:00
README.md updated documentation for mentioning images vs containers 2014-05-29 11:20:41 +10:00
registry_api.md Reformat the API docs so I can read them 2014-09-09 16:17:38 +10:00
remote_api_client_libraries.md Update remote_api_client_libraries.md 2014-09-11 03:04:35 -04:00

This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes:

  • The remote API by which a docker node can be queried over HTTP
  • The registry API by which a docker node can download and upload images for storage and sharing
  • The index search API by which a docker node can search the public index for images to download
  • The docker.io OAuth and accounts API which 3rd party services can use to access account information