Move API reference to new location
See: https://github.com/docker/docker.github.io/pull/606 Also: - Add missing redirects to API reference pages - Remove v1.25 and 1.26, because they are being replaced with swagger generated docs. - Remove all other docs which aren't reference material, because this can live in docker/docker.github.io Signed-off-by: Ben Firshman <ben@firshman.co.uk>
This commit is contained in:
Ben Firshman
parent
48c3df015d
commit
993854f58f
|
|
@ -2,6 +2,9 @@
|
|||
title: "Remote API v1.18"
|
||||
description: "API Documentation for Docker"
|
||||
keywords: "API, Docker, rcli, REST, documentation"
|
||||
redirect_from:
|
||||
- /engine/reference/api/docker_remote_api_v1.18/
|
||||
- /reference/api/docker_remote_api_v1.18/
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
|
|
@ -2,6 +2,9 @@
|
|||
title: "Remote API v1.19"
|
||||
description: "API Documentation for Docker"
|
||||
keywords: "API, Docker, rcli, REST, documentation"
|
||||
redirect_from:
|
||||
- /engine/reference/api/docker_remote_api_v1.19/
|
||||
- /reference/api/docker_remote_api_v1.19/
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
|
|
@ -2,6 +2,9 @@
|
|||
title: "Remote API v1.20"
|
||||
description: "API Documentation for Docker"
|
||||
keywords: "API, Docker, rcli, REST, documentation"
|
||||
redirect_from:
|
||||
- /engine/reference/api/docker_remote_api_v1.20/
|
||||
- /reference/api/docker_remote_api_v1.20/
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
|
|
@ -2,6 +2,9 @@
|
|||
title: "Remote API v1.21"
|
||||
description: "API Documentation for Docker"
|
||||
keywords: "API, Docker, rcli, REST, documentation"
|
||||
redirect_from:
|
||||
- /engine/reference/api/docker_remote_api_v1.21/
|
||||
- /reference/api/docker_remote_api_v1.21/
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
|
|
@ -2,6 +2,9 @@
|
|||
title: "Remote API v1.22"
|
||||
description: "API Documentation for Docker"
|
||||
keywords: "API, Docker, rcli, REST, documentation"
|
||||
redirect_from:
|
||||
- /engine/reference/api/docker_remote_api_v1.22/
|
||||
- /reference/api/docker_remote_api_v1.22/
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
|
|
@ -2,6 +2,9 @@
|
|||
title: "Remote API v1.23"
|
||||
description: "API Documentation for Docker"
|
||||
keywords: "API, Docker, rcli, REST, documentation"
|
||||
redirect_from:
|
||||
- /engine/reference/api/docker_remote_api_v1.23/
|
||||
- /reference/api/docker_remote_api_v1.23/
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
|
|
@ -2,6 +2,9 @@
|
|||
title: "Remote API v1.24"
|
||||
description: "API Documentation for Docker"
|
||||
keywords: "API, Docker, rcli, REST, documentation"
|
||||
redirect_from:
|
||||
- /engine/reference/api/docker_remote_api_v1.24/
|
||||
- /reference/api/docker_remote_api_v1.24/
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Remote API"
|
||||
description: "API Documentation for Docker"
|
||||
title: "Remote API version history"
|
||||
description: "Documentation of changes that have been made to Engine API."
|
||||
keywords: "API, Docker, rcli, REST, documentation"
|
||||
---
|
||||
|
||||
|
|
@ -13,137 +13,12 @@ keywords: "API, Docker, rcli, REST, documentation"
|
|||
will be rejected.
|
||||
-->
|
||||
|
||||
# Docker Remote API
|
||||
|
||||
Docker's Remote API uses an open schema model. In this model, unknown
|
||||
properties in incoming messages are ignored. Client applications need to take
|
||||
this behavior into account to ensure they do not break when talking to newer
|
||||
Docker daemons.
|
||||
|
||||
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.
|
||||
|
||||
By default the Docker daemon listens on `unix:///var/run/docker.sock` and the
|
||||
client must have `root` access to interact with the daemon. If a group named
|
||||
`docker` exists on your system, `docker` applies ownership of the socket to the
|
||||
group.
|
||||
|
||||
To connect to the Docker daemon with cURL you need to use cURL 7.40 or
|
||||
later, as these versions have the `--unix-socket` flag available. To
|
||||
run `curl` against the daemon on the default socket, use the
|
||||
following:
|
||||
|
||||
When using cUrl 7.50 or later:
|
||||
|
||||
```console
|
||||
$ curl --unix-socket /var/run/docker.sock http://localhost/v1.25/containers/json
|
||||
```
|
||||
|
||||
When using cURL 7.40, `localhost` must be omitted:
|
||||
|
||||
```console
|
||||
$ curl --unix-socket /var/run/docker.sock http://v1.25/containers/json
|
||||
```
|
||||
|
||||
If you have bound the Docker daemon to a different socket path or TCP
|
||||
port, you would reference that in your cURL rather than the
|
||||
default.
|
||||
|
||||
## Versioning
|
||||
|
||||
It is required to to supply a version to API calls. This is done by prefixing
|
||||
the URL with the version number.
|
||||
|
||||
The current version of the API is 1.26, so to call the `/info` endpoint, you
|
||||
would send a request to the URL `/v1.26/info`. To call, for example, version
|
||||
1.24 of the API instead, you would request `/v1.24/info`.
|
||||
|
||||
If a newer daemon is installed, new properties may be returned even when
|
||||
calling older versions of the API.
|
||||
|
||||
In previous versions of Docker, it was possible to access the API without
|
||||
providing a version. This behaviour is now deprecated will be removed in a
|
||||
future version of Docker.
|
||||
|
||||
Use the table below to find the API version for a Docker version:
|
||||
|
||||
Docker version | API version | Changes
|
||||
----------------|------------------------------------|------------------------------------------------------
|
||||
1.14.x | [1.26](docker_remote_api_v1.26.md) | [API changes](docker_remote_api.md#v1-26-api-changes)
|
||||
1.13.x | [1.25](docker_remote_api_v1.25.md) | [API changes](docker_remote_api.md#v1-25-api-changes)
|
||||
1.12.x | [1.24](docker_remote_api_v1.24.md) | [API changes](docker_remote_api.md#v1-24-api-changes)
|
||||
1.11.x | [1.23](docker_remote_api_v1.23.md) | [API changes](docker_remote_api.md#v1-23-api-changes)
|
||||
1.10.x | [1.22](docker_remote_api_v1.22.md) | [API changes](docker_remote_api.md#v1-22-api-changes)
|
||||
1.9.x | [1.21](docker_remote_api_v1.21.md) | [API changes](docker_remote_api.md#v1-21-api-changes)
|
||||
1.8.x | [1.20](docker_remote_api_v1.20.md) | [API changes](docker_remote_api.md#v1-20-api-changes)
|
||||
1.7.x | [1.19](docker_remote_api_v1.19.md) | [API changes](docker_remote_api.md#v1-19-api-changes)
|
||||
1.6.x | [1.18](docker_remote_api_v1.18.md) | [API changes](docker_remote_api.md#v1-18-api-changes)
|
||||
|
||||
Refer to the [GitHub repository](
|
||||
https://github.com/docker/docker/tree/master/docs/reference/api) for
|
||||
older releases.
|
||||
|
||||
## Authentication
|
||||
|
||||
Authentication configuration is handled client side, so the
|
||||
client has to send the `authConfig` as a `POST` in `/images/(name)/push`. The
|
||||
`authConfig`, set as the `X-Registry-Auth` header, is currently a Base64 encoded
|
||||
(JSON) string with the following structure:
|
||||
|
||||
```JSON
|
||||
{"username": "string", "password": "string", "email": "string",
|
||||
"serveraddress" : "string", "auth": ""}
|
||||
```
|
||||
|
||||
Callers should leave the `auth` empty. The `serveraddress` is a domain/ip
|
||||
without protocol. Throughout this structure, double quotes are required.
|
||||
|
||||
## Using Docker Machine with the API
|
||||
|
||||
If you are using `docker-machine`, the Docker daemon is on a host that
|
||||
uses an encrypted TCP socket using TLS. This means, for Docker Machine users,
|
||||
you need to add extra parameters to `curl` or `wget` when making test
|
||||
API requests, for example:
|
||||
|
||||
```
|
||||
curl --insecure \
|
||||
--cert $DOCKER_CERT_PATH/cert.pem \
|
||||
--key $DOCKER_CERT_PATH/key.pem \
|
||||
https://YOUR_VM_IP:2376/v1.25/images/json
|
||||
|
||||
wget --no-check-certificate --certificate=$DOCKER_CERT_PATH/cert.pem \
|
||||
--private-key=$DOCKER_CERT_PATH/key.pem \
|
||||
https://YOUR_VM_IP:2376/v1.25/images/json -O - -q
|
||||
```
|
||||
|
||||
## Docker Events
|
||||
|
||||
The following diagram depicts the container states accessible through the API.
|
||||
|
||||
|
||||
|
||||
Some container-related events are not affected by container state, so they are not included in this diagram. These events are:
|
||||
|
||||
* **export** emitted by `docker export`
|
||||
* **exec_create** emitted by `docker exec`
|
||||
* **exec_start** emitted by `docker exec` after **exec_create**
|
||||
* **detach** emitted when client is detached from container process
|
||||
* **exec_detach** emitted when client is detached from exec process
|
||||
|
||||
Running `docker rmi` emits an **untag** event when removing an image name. The `rmi` command may also emit **delete** events when images are deleted by ID directly or by deleting the last tag referring to the image.
|
||||
|
||||
> **Acknowledgment**: This diagram and the accompanying text were used with the permission of Matt Good and Gilder Labs. See Matt's original blog post [Docker Events Explained](https://gliderlabs.com/blog/2015/04/14/docker-events-explained/).
|
||||
|
||||
## Version history
|
||||
|
||||
This section lists each version from latest to oldest. Each listing includes a link to the full documentation set and the changes relevant in that release.
|
||||
|
||||
### v1.26 API changes
|
||||
## v1.26 API changes
|
||||
|
||||
[Docker Remote API v1.26](docker_remote_api_v1.26.md) documentation
|
||||
|
||||
|
||||
### v1.25 API changes
|
||||
## v1.25 API changes
|
||||
|
||||
[Docker Remote API v1.25](docker_remote_api_v1.25.md) documentation
|
||||
|
||||
|
|
@ -204,7 +79,7 @@ This section lists each version from latest to oldest. Each listing includes a
|
|||
* `GET /images/json` now support a `reference` filter.
|
||||
|
||||
|
||||
### v1.24 API changes
|
||||
## v1.24 API changes
|
||||
|
||||
[Docker Remote API v1.24](docker_remote_api_v1.24.md) documentation
|
||||
|
||||
|
|
@ -236,7 +111,7 @@ This section lists each version from latest to oldest. Each listing includes a
|
|||
* `POST /containers/create/` `HostConfig.PidMode` field now accepts `container:<name|id>`,
|
||||
to have the container join the PID namespace of an existing container.
|
||||
|
||||
### v1.23 API changes
|
||||
## v1.23 API changes
|
||||
|
||||
[Docker Remote API v1.23](docker_remote_api_v1.23.md) documentation
|
||||
|
||||
|
|
@ -258,7 +133,7 @@ This section lists each version from latest to oldest. Each listing includes a
|
|||
* `GET /containers/(id or name)/logs` now accepts a `details` query parameter to stream the extra attributes that were provided to the containers `LogOpts`, such as environment variables and labels, with the logs.
|
||||
* `POST /images/load` now returns progress information as a JSON stream, and has a `quiet` query parameter to suppress progress details.
|
||||
|
||||
### v1.22 API changes
|
||||
## v1.22 API changes
|
||||
|
||||
[Docker Remote API v1.22](docker_remote_api_v1.22.md) documentation
|
||||
|
||||
|
|
@ -292,7 +167,7 @@ This section lists each version from latest to oldest. Each listing includes a
|
|||
* `GET /info` can now return a `SystemStatus` field useful for returning additional information about applications
|
||||
that are built on top of engine.
|
||||
|
||||
### v1.21 API changes
|
||||
## v1.21 API changes
|
||||
|
||||
[Docker Remote API v1.21](docker_remote_api_v1.21.md) documentation
|
||||
|
||||
|
|
@ -327,7 +202,7 @@ This section lists each version from latest to oldest. Each listing includes a
|
|||
badness heuristic. This heuristic selects which processes the OOM killer kills
|
||||
under out-of-memory conditions.
|
||||
|
||||
### v1.20 API changes
|
||||
## v1.20 API changes
|
||||
|
||||
[Docker Remote API v1.20](docker_remote_api_v1.20.md) documentation
|
||||
|
||||
|
|
@ -339,7 +214,7 @@ endpoint which can be used to download files and directories from a container.
|
|||
* The `hostConfig` option now accepts the field `GroupAdd`, which specifies a
|
||||
list of additional groups that the container process will run as.
|
||||
|
||||
### v1.19 API changes
|
||||
## v1.19 API changes
|
||||
|
||||
[Docker Remote API v1.19](docker_remote_api_v1.19.md) documentation
|
||||
|
||||
|
|
@ -355,7 +230,7 @@ end point now returns the new boolean fields `CpuCfsPeriod`, `CpuCfsQuota`, and
|
|||
* The `hostConfig` option now accepts the fields `CpuPeriod` and `CpuQuota`
|
||||
* `POST /build` accepts `cpuperiod` and `cpuquota` options
|
||||
|
||||
### v1.18 API changes
|
||||
## v1.18 API changes
|
||||
|
||||
[Docker Remote API v1.18](docker_remote_api_v1.18.md) documentation
|
||||
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
---
|
||||
published: false
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
repository at https://github.com/docker/docker/. Make all
|
||||
pull requests against that repo. If you see this file in
|
||||
another repository, consider it read-only there, as it will
|
||||
periodically be overwritten by the definitive file. Pull
|
||||
requests which include edits to this file in other repositories
|
||||
will be rejected.
|
||||
-->
|
||||
|
||||
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
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 38 KiB |
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
published: false
|
||||
title: "Docker Hub API"
|
||||
description: "API Documentation for the Docker Hub API"
|
||||
keywords: "API, Docker, index, REST, documentation, Docker Hub, registry"
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
repository at https://github.com/docker/docker/. Make all
|
||||
pull requests against that repo. If you see this file in
|
||||
another repository, consider it read-only there, as it will
|
||||
periodically be overwritten by the definitive file. Pull
|
||||
requests which include edits to this file in other repositories
|
||||
will be rejected.
|
||||
-->
|
||||
|
||||
# Docker Hub API
|
||||
|
||||
This API is deprecated as of 1.7. To view the old version, see the [Docker Hub
|
||||
API](https://docs.docker.com/v1.7/docker/reference/api/docker-io_api/) in the 1.7 documentation.
|
||||
|
|
@ -1,281 +0,0 @@
|
|||
---
|
||||
title: "docker.io accounts API"
|
||||
description: "API Documentation for docker.io accounts."
|
||||
keywords: "API, Docker, accounts, REST, documentation"
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
repository at https://github.com/docker/docker/. Make all
|
||||
pull requests against that repo. If you see this file in
|
||||
another repository, consider it read-only there, as it will
|
||||
periodically be overwritten by the definitive file. Pull
|
||||
requests which include edits to this file in other repositories
|
||||
will be rejected.
|
||||
-->
|
||||
|
||||
# docker.io accounts API
|
||||
|
||||
## Get a single user
|
||||
|
||||
`GET /api/v1.1/users/:username/`
|
||||
|
||||
Get profile info for the specified user.
|
||||
|
||||
Parameters:
|
||||
|
||||
- **username** – username of the user whose profile info is being
|
||||
requested.
|
||||
|
||||
Request Headers:
|
||||
|
||||
- **Authorization** – required authentication credentials of
|
||||
either type HTTP Basic or OAuth Bearer Token.
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **200** – success, user data returned.
|
||||
- **401** – authentication error.
|
||||
- **403** – permission error, authenticated user must be the user
|
||||
whose data is being requested, OAuth access tokens must have
|
||||
`profile_read` scope.
|
||||
- **404** – the specified username does not exist.
|
||||
|
||||
**Example request**:
|
||||
|
||||
GET /api/v1.1/users/janedoe/ HTTP/1.1
|
||||
Host: www.docker.io
|
||||
Accept: application/json
|
||||
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"id": 2,
|
||||
"username": "janedoe",
|
||||
"url": "https://www.docker.io/api/v1.1/users/janedoe/",
|
||||
"date_joined": "2014-02-12T17:58:01.431312Z",
|
||||
"type": "User",
|
||||
"full_name": "Jane Doe",
|
||||
"location": "San Francisco, CA",
|
||||
"company": "Success, Inc.",
|
||||
"profile_url": "https://docker.io/",
|
||||
"gravatar_url": "https://secure.gravatar.com/avatar/0212b397124be4acd4e7dea9aa357.jpg?s=80&r=g&d=mm"
|
||||
"email": "jane.doe@example.com",
|
||||
"is_active": true
|
||||
}
|
||||
|
||||
## Update a single user
|
||||
|
||||
`PATCH /api/v1.1/users/:username/`
|
||||
|
||||
Update profile info for the specified user.
|
||||
|
||||
Parameters:
|
||||
|
||||
- **username** – username of the user whose profile info is being
|
||||
updated.
|
||||
|
||||
Json Parameters:
|
||||
|
||||
- **full_name** (*string*) – (optional) the new name of the user.
|
||||
- **location** (*string*) – (optional) the new location.
|
||||
- **company** (*string*) – (optional) the new company of the user.
|
||||
- **profile_url** (*string*) – (optional) the new profile url.
|
||||
- **gravatar_email** (*string*) – (optional) the new Gravatar
|
||||
email address.
|
||||
|
||||
Request Headers:
|
||||
|
||||
- **Authorization** – required authentication credentials of
|
||||
either type HTTP Basic or OAuth Bearer Token.
|
||||
- **Content-Type** – MIME Type of post data. JSON, url-encoded
|
||||
form data, etc.
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **200** – success, user data updated.
|
||||
- **400** – post data validation error.
|
||||
- **401** – authentication error.
|
||||
- **403** – permission error, authenticated user must be the user
|
||||
whose data is being updated, OAuth access tokens must have
|
||||
`profile_write` scope.
|
||||
- **404** – the specified username does not exist.
|
||||
|
||||
**Example request**:
|
||||
|
||||
PATCH /api/v1.1/users/janedoe/ HTTP/1.1
|
||||
Host: www.docker.io
|
||||
Accept: application/json
|
||||
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
|
||||
|
||||
{
|
||||
"location": "Private Island",
|
||||
"profile_url": "http://janedoe.com/",
|
||||
"company": "Retired",
|
||||
}
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"id": 2,
|
||||
"username": "janedoe",
|
||||
"url": "https://www.docker.io/api/v1.1/users/janedoe/",
|
||||
"date_joined": "2014-02-12T17:58:01.431312Z",
|
||||
"type": "User",
|
||||
"full_name": "Jane Doe",
|
||||
"location": "Private Island",
|
||||
"company": "Retired",
|
||||
"profile_url": "http://janedoe.com/",
|
||||
"gravatar_url": "https://secure.gravatar.com/avatar/0212b397124be4acd4e7dea9aa357.jpg?s=80&r=g&d=mm"
|
||||
"email": "jane.doe@example.com",
|
||||
"is_active": true
|
||||
}
|
||||
|
||||
## List email addresses for a user
|
||||
|
||||
`GET /api/v1.1/users/:username/emails/`
|
||||
|
||||
List email info for the specified user.
|
||||
|
||||
Parameters:
|
||||
|
||||
- **username** – username of the user whose profile info is being
|
||||
updated.
|
||||
|
||||
Request Headers:
|
||||
|
||||
- **Authorization** – required authentication credentials of
|
||||
either type HTTP Basic or OAuth Bearer Token
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **200** – success, user data updated.
|
||||
- **401** – authentication error.
|
||||
- **403** – permission error, authenticated user must be the user
|
||||
whose data is being requested, OAuth access tokens must have
|
||||
`email_read` scope.
|
||||
- **404** – the specified username does not exist.
|
||||
|
||||
**Example request**:
|
||||
|
||||
GET /api/v1.1/users/janedoe/emails/ HTTP/1.1
|
||||
Host: www.docker.io
|
||||
Accept: application/json
|
||||
Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
|
||||
[
|
||||
{
|
||||
"email": "jane.doe@example.com",
|
||||
"verified": true,
|
||||
"primary": true
|
||||
}
|
||||
]
|
||||
|
||||
## Add email address for a user
|
||||
|
||||
`POST /api/v1.1/users/:username/emails/`
|
||||
|
||||
Add a new email address to the specified user's account. The email
|
||||
address must be verified separately, a confirmation email is not
|
||||
automatically sent.
|
||||
|
||||
Json Parameters:
|
||||
|
||||
- **email** (*string*) – email address to be added.
|
||||
|
||||
Request Headers:
|
||||
|
||||
- **Authorization** – required authentication credentials of
|
||||
either type HTTP Basic or OAuth Bearer Token.
|
||||
- **Content-Type** – MIME Type of post data. JSON, url-encoded
|
||||
form data, etc.
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **201** – success, new email added.
|
||||
- **400** – data validation error.
|
||||
- **401** – authentication error.
|
||||
- **403** – permission error, authenticated user must be the user
|
||||
whose data is being requested, OAuth access tokens must have
|
||||
`email_write` scope.
|
||||
- **404** – the specified username does not exist.
|
||||
|
||||
**Example request**:
|
||||
|
||||
POST /api/v1.1/users/janedoe/emails/ HTTP/1.1
|
||||
Host: www.docker.io
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM
|
||||
|
||||
{
|
||||
"email": "jane.doe+other@example.com"
|
||||
}
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 201 Created
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"email": "jane.doe+other@example.com",
|
||||
"verified": false,
|
||||
"primary": false
|
||||
}
|
||||
|
||||
## Delete email address for a user
|
||||
|
||||
`DELETE /api/v1.1/users/:username/emails/`
|
||||
|
||||
Delete an email address from the specified user's account. You
|
||||
cannot delete a user's primary email address.
|
||||
|
||||
Json Parameters:
|
||||
|
||||
- **email** (*string*) – email address to be deleted.
|
||||
|
||||
Request Headers:
|
||||
|
||||
- **Authorization** – required authentication credentials of
|
||||
either type HTTP Basic or OAuth Bearer Token.
|
||||
- **Content-Type** – MIME Type of post data. JSON, url-encoded
|
||||
form data, etc.
|
||||
|
||||
Status Codes:
|
||||
|
||||
- **204** – success, email address removed.
|
||||
- **400** – validation error.
|
||||
- **401** – authentication error.
|
||||
- **403** – permission error, authenticated user must be the user
|
||||
whose data is being requested, OAuth access tokens must have
|
||||
`email_write` scope.
|
||||
- **404** – the specified username or email address does not
|
||||
exist.
|
||||
|
||||
**Example request**:
|
||||
|
||||
DELETE /api/v1.1/users/janedoe/emails/ HTTP/1.1
|
||||
Host: www.docker.io
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM
|
||||
|
||||
{
|
||||
"email": "jane.doe+other@example.com"
|
||||
}
|
||||
|
||||
**Example response**:
|
||||
|
||||
HTTP/1.1 204 NO CONTENT
|
||||
Content-Length: 0
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -1,23 +0,0 @@
|
|||
---
|
||||
published: false
|
||||
title: "The Docker Hub and the Registry v1"
|
||||
description: "Documentation for docker Registry and Registry API"
|
||||
keywords: "docker, registry, api, hub"
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
repository at https://github.com/docker/docker/. Make all
|
||||
pull requests against that repo. If you see this file in
|
||||
another repository, consider it read-only there, as it will
|
||||
periodically be overwritten by the definitive file. Pull
|
||||
requests which include edits to this file in other repositories
|
||||
will be rejected.
|
||||
-->
|
||||
|
||||
# The Docker Hub and the Registry v1
|
||||
|
||||
This API is deprecated as of 1.7. To view the old version, see the [go
|
||||
here](https://docs.docker.com/v1.7/docker/reference/api/hub_registry_spec/) in
|
||||
the 1.7 documentation. If you want an overview of the current features in
|
||||
Docker Hub or other image management features see the [image management
|
||||
overview](https://docs.docker.com/engine/userguide/eng-image/image_management/) in the current documentation set.
|
||||
File diff suppressed because one or more lines are too long
Binary file not shown.
|
Before Width: | Height: | Size: 76 KiB |
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
title: "API Reference"
|
||||
description: "Reference"
|
||||
keywords: "Engine"
|
||||
identifier: "engine_remoteapi"
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
repository at https://github.com/docker/docker/. Make all
|
||||
pull requests against that repo. If you see this file in
|
||||
another repository, consider it read-only there, as it will
|
||||
periodically be overwritten by the definitive file. Pull
|
||||
requests which include edits to this file in other repositories
|
||||
will be rejected.
|
||||
-->
|
||||
|
||||
# API Reference
|
||||
|
||||
* [Docker Remote API](docker_remote_api.md)
|
||||
* [Docker Remote API client libraries](remote_api_client_libraries.md)
|
||||
|
|
@ -1,138 +0,0 @@
|
|||
---
|
||||
title: "Remote API client libraries"
|
||||
description: "Various client libraries available to use with the Docker remote API"
|
||||
keywords: "API, Docker, index, registry, REST, documentation, clients, C#, Erlang, Go, Groovy, Java, JavaScript, Perl, PHP, Python, Ruby, Rust, Scala"
|
||||
---
|
||||
|
||||
<!-- This file is maintained within the docker/docker Github
|
||||
repository at https://github.com/docker/docker/. Make all
|
||||
pull requests against that repo. If you see this file in
|
||||
another repository, consider it read-only there, as it will
|
||||
periodically be overwritten by the definitive file. Pull
|
||||
requests which include edits to this file in other repositories
|
||||
will be rejected.
|
||||
-->
|
||||
|
||||
# Docker Remote API client libraries
|
||||
|
||||
These libraries make it easier to build applications on top of the Docker
|
||||
Remote API with various programming languages. They have not been tested by the
|
||||
Docker maintainers for compatibility, so if you run into any issues, file them
|
||||
with the library maintainers.
|
||||
|
||||
<table border="1" class="docutils">
|
||||
<colgroup>
|
||||
<col width="29%">
|
||||
<col width="23%">
|
||||
<col width="48%">
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr>
|
||||
<th class="head">Language/Framework</th>
|
||||
<th class="head">Name</th>
|
||||
<th class="head">Repository</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign = "top">
|
||||
<tr>
|
||||
<td>C#</td>
|
||||
<td>Docker.DotNet</td>
|
||||
<td><a class="reference external" href="https://github.com/ahmetalpbalkan/Docker.DotNet">https://github.com/ahmetalpbalkan/Docker.DotNet</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>C++</td>
|
||||
<td>lasote/docker_client</td>
|
||||
<td><a class="reference external" href="https://github.com/lasote/docker_client">https://github.com/lasote/docker_client</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Erlang</td>
|
||||
<td>erldocker</td>
|
||||
<td><a class="reference external" href="https://github.com/proger/erldocker">https://github.com/proger/erldocker</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Dart</td>
|
||||
<td>bwu_docker</td>
|
||||
<td><a class="reference external" href="https://github.com/bwu-dart/bwu_docker">https://github.com/bwu-dart/bwu_docker</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Go</td>
|
||||
<td>Docker Go client</td>
|
||||
<td><a class="reference external" href="https://godoc.org/github.com/docker/docker/client">https://godoc.org/github.com/docker/docker/client</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Gradle</td>
|
||||
<td>gradle-docker-plugin</td>
|
||||
<td><a class="reference external" href="https://github.com/gesellix/gradle-docker-plugin">https://github.com/gesellix/gradle-docker-plugin</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Groovy</td>
|
||||
<td>docker-client</td>
|
||||
<td><a class="reference external" href="https://github.com/gesellix/docker-client">https://github.com/gesellix/docker-client</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Haskell</td>
|
||||
<td>docker-hs</td>
|
||||
<td><a class="reference external" href="https://github.com/denibertovic/docker-hs">https://github.com/denibertovic/docker-hs</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>HTML (Web Components)</td>
|
||||
<td>docker-elements</td>
|
||||
<td><a class="reference external" href="https://github.com/kapalhq/docker-elements">https://github.com/kapalhq/docker-elements</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Java</td>
|
||||
<td>docker-java</td>
|
||||
<td><a class="reference external" href="https://github.com/docker-java/docker-java">https://github.com/docker-java/docker-java</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Java</td>
|
||||
<td>docker-client</td>
|
||||
<td><a class="reference external" href="https://github.com/spotify/docker-client">https://github.com/spotify/docker-client</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>NodeJS</td>
|
||||
<td>dockerode</td>
|
||||
<td><a class="reference external" href="https://github.com/apocas/dockerode">https://github.com/apocas/dockerode</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Perl</td>
|
||||
<td>Eixo::Docker</td>
|
||||
<td><a class="reference external" href="https://github.com/alambike/eixo-docker">https://github.com/alambike/eixo-docker</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>PHP</td>
|
||||
<td>Docker-PHP</td>
|
||||
<td><a class="reference external" href="https://github.com/docker-php/docker-php">https://github.com/docker-php/docker-php</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Python</td>
|
||||
<td>docker-py</td>
|
||||
<td><a class="reference external" href="https://github.com/docker/docker-py">https://github.com/docker/docker-py</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Ruby</td>
|
||||
<td>docker-api</td>
|
||||
<td><a class="reference external" href="https://github.com/swipely/docker-api">https://github.com/swipely/docker-api</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Rust</td>
|
||||
<td>docker-rust</td>
|
||||
<td><a class="reference external" href="https://github.com/abh1nav/docker-rust">https://github.com/abh1nav/docker-rust</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Rust</td>
|
||||
<td>shiplift</td>
|
||||
<td><a class="reference external" href="https://github.com/softprops/shiplift">https://github.com/softprops/shiplift</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Scala</td>
|
||||
<td>tugboat</td>
|
||||
<td><a class="reference external" href="https://github.com/softprops/tugboat">https://github.com/softprops/tugboat</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Scala</td>
|
||||
<td>reactive-docker</td>
|
||||
<td><a class="reference external" href="https://github.com/almoehi/reactive-docker">https://github.com/almoehi/reactive-docker</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
Loading…
Reference in New Issue