Merge pull request #28506 from bfirsh/prepare-api-docs-for-swagger-docs
Prepare docs and Swagger definition for automatically generated API docs
This commit is contained in:
Sebastiaan van Stijn
GitHub
commit
313502488e
45 changed files with 588 additions and 13087 deletions
|
|
@ -1,5 +1,42 @@
|
|||
This directory contains code pertaining to the Docker API:
|
||||
# Working on the Engine API
|
||||
|
||||
- Used by the docker client when communicating with the docker daemon
|
||||
The Engine API is an HTTP API used by the command-line client to communicate with the daemon. It can also be used by third-party software to control the daemon.
|
||||
|
||||
- Used by third party tools wishing to interface with the docker daemon
|
||||
It consists of various components in this repository:
|
||||
|
||||
- `api/swagger.yaml` A Swagger definition of the API.
|
||||
- `api/types/` Types shared by both the client and server, representing various objects, options, responses, etc. Most are written manually, but some are automatically generated from the Swagger definition. See [#27919](https://github.com/docker/docker/issues/27919) for progress on this.
|
||||
- `cli/` The command-line client.
|
||||
- `client/` The Go client used by the command-line client. It can also be used by third-party Go programs.
|
||||
- `daemon/` The daemon, which serves the API.
|
||||
|
||||
## Swagger definition
|
||||
|
||||
The API is defined by the [Swagger](http://swagger.io/specification/) definition in `api/swagger.yaml`. This definition can be used to:
|
||||
|
||||
1. To automatically generate documentation.
|
||||
2. To automatically generate the Go server and client. (A work-in-progress.)
|
||||
3. Provide a machine readable version of the API for introspecting what it can do, automatically generating clients for other languages, etc.
|
||||
|
||||
## Updating the API documentation
|
||||
|
||||
The API documentation is generated entirely from `api/swagger.yaml`. If you make updates to the API, you'll need to edit this file to represent the change in the documentation.
|
||||
|
||||
The file is split into two main sections:
|
||||
|
||||
- `definitions`, which defines re-usable objects used in requests and responses
|
||||
- `paths`, which defines the API endpoints (and some inline objects which don't need to be reusable)
|
||||
|
||||
To make an edit, first look for the endpoint you want to edit under `paths`, then make the required edits. Endpoints may reference reusable objects with `$ref`, which can be found in the `definitions` section.
|
||||
|
||||
There is hopefully enough example material in the file for you to copy a similar pattern from elsewhere in the file (e.g. adding new fields or endpoints), but for the full reference, see the [Swagger specification](https://github.com/docker/docker/issues/27919)
|
||||
|
||||
`swagger.yaml` is validated by `hack/validate/swagger` to ensure it is a valid Swagger definition. This is useful for when you are making edits to ensure you are doing the right thing.
|
||||
|
||||
## Viewing the API documentation
|
||||
|
||||
When you make edits to `swagger.yaml`, you may want to check the generated API documentation to ensure it renders correctly.
|
||||
|
||||
All the documentation generation is done in the documentation repository, [docker/docker.github.io](https://github.com/docker/docker.github.io). The Swagger definition is vendored periodically into this repository, but you can manually copy over the Swagger definition to test changes.
|
||||
|
||||
Copy `api/swagger.yaml` in this repository to `engine/api/[VERSION_NUMBER]/swagger.yaml` in the documentation repository, overwriting what is already there. Then, run `docker-compose up` in the documentation repository and browse to [http://localhost:4000/engine/api/](http://localhost:4000/engine/api/) when it finishes rendering.
|
||||
|
|
|
|||
454
api/swagger.yaml
454
api/swagger.yaml
|
|
@ -10,18 +10,18 @@ consumes:
|
|||
- "text/plain"
|
||||
basePath: "/v1.26"
|
||||
info:
|
||||
title: "Docker Remote API"
|
||||
title: "Docker Engine API"
|
||||
version: "1.26"
|
||||
x-logo:
|
||||
url: "https://docs.docker.com/images/logo-docker-main.png"
|
||||
description: |
|
||||
The Docker API is an HTTP REST API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API.
|
||||
The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API.
|
||||
|
||||
Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls. [There is example of using `curl` to run a container in the SDK documentation.](#TODO)
|
||||
Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls.
|
||||
|
||||
# Errors
|
||||
|
||||
The Remote API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:
|
||||
The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:
|
||||
|
||||
```
|
||||
{
|
||||
|
|
@ -31,12 +31,29 @@ info:
|
|||
|
||||
# Versioning
|
||||
|
||||
The API is usually changed in each release of Docker. If you want to write a client that doesn't break when connecting to newer Docker releases, you can lock to a specific API version.
|
||||
The API is usually changed in each release of Docker, so API calls are versioned to ensure that clients don't break.
|
||||
|
||||
For Docker 1.14, the API version is 1.26. To lock to this version, you prefix the URL with `/v1.26`. For example, calling `/info` is the same as calling `/v1.26/info`.
|
||||
For Docker Engine 1.14, the API version is 1.26. To lock to this version, you prefix the URL with `/v1.25`. For example, calling `/info` is the same as calling `/v1.25/info`.
|
||||
|
||||
Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine.
|
||||
|
||||
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.
|
||||
|
||||
The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer Docker daemons.
|
||||
|
||||
This documentation is for version 1.26 of the API, which was introduced with Docker 1.14. Use this table to find documentation for previous versions of the API:
|
||||
|
||||
Docker version | API version | Changes
|
||||
----------------|-------------|---------
|
||||
1.13.x | [1.25](/engine/api/v1.24/) | [API changes](/engine/api/version-history/#v1-24-api-changes)
|
||||
1.12.x | [1.24](/engine/api/v1.24/) | [API changes](/engine/api/version-history/#v1-24-api-changes)
|
||||
1.11.x | [1.23](/engine/api/v1.23/) | [API changes](/engine/api/version-history/#v1-23-api-changes)
|
||||
1.10.x | [1.22](/engine/api/v1.22/) | [API changes](/engine/api/version-history/#v1-22-api-changes)
|
||||
1.9.x | [1.21](/engine/api/v1.21/) | [API changes](/engine/api/version-history/#v1-21-api-changes)
|
||||
1.8.x | [1.20](/engine/api/v1.20/) | [API changes](/engine/api/version-history/#v1-20-api-changes)
|
||||
1.7.x | [1.19](/engine/api/v1.19/) | [API changes](/engine/api/version-history/#v1-19-api-changes)
|
||||
1.6.x | [1.18](/engine/api/v1.18/) | [API changes](/engine/api/version-history/#v1-18-api-changes)
|
||||
|
||||
# Authentication
|
||||
|
||||
Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a Base64 encoded (JSON) string with the following structure:
|
||||
|
|
@ -543,7 +560,8 @@ definitions:
|
|||
type: "string"
|
||||
Tmpfs:
|
||||
type: "object"
|
||||
description: "List of tmpfs mounts for this container."
|
||||
description: |
|
||||
A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: `{ "/run": "rw,noexec,nosuid,size=65536k" }`.
|
||||
additionalProperties:
|
||||
type: "string"
|
||||
UTSMode:
|
||||
|
|
@ -1262,7 +1280,7 @@ definitions:
|
|||
x-nullable: false
|
||||
|
||||
Plugin:
|
||||
description: "A plugin for the Remote API"
|
||||
description: "A plugin for the Engine API"
|
||||
type: "object"
|
||||
required: [Settings, Enabled, Config, Name, Tag]
|
||||
properties:
|
||||
|
|
@ -1684,6 +1702,13 @@ definitions:
|
|||
type: "object"
|
||||
additionalProperties:
|
||||
type: "string"
|
||||
EncryptionConfig:
|
||||
description: "Parameters related to encryption-at-rest."
|
||||
type: "object"
|
||||
properties:
|
||||
AutoLockManagers:
|
||||
description: "If set, generate a key and use it to lock data stored on the managers."
|
||||
type: "boolean"
|
||||
TaskDefaults:
|
||||
description: "Defaults for creating tasks in this cluster."
|
||||
type: "object"
|
||||
|
|
@ -1717,6 +1742,8 @@ definitions:
|
|||
JoinTokens:
|
||||
Worker: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx"
|
||||
Manager: "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2"
|
||||
EncryptionConfig:
|
||||
AutoLockManagers: false
|
||||
# The Swarm information for `GET /info`. It is the same as `GET /swarm`, but
|
||||
# without `JoinTokens`.
|
||||
ClusterInfo:
|
||||
|
|
@ -1787,6 +1814,25 @@ definitions:
|
|||
description: "Amount of time to wait for the container to terminate before forcefully killing it."
|
||||
type: "integer"
|
||||
format: "int64"
|
||||
DNSConfig:
|
||||
description: "Specification for DNS related configurations in resolver configuration file (`resolv.conf`)."
|
||||
type: "object"
|
||||
properties:
|
||||
Nameservers:
|
||||
description: "The IP addresses of the name servers."
|
||||
type: "array"
|
||||
items:
|
||||
type: "string"
|
||||
Search:
|
||||
description: "A search list for host-name lookup."
|
||||
type: "array"
|
||||
items:
|
||||
type: "string"
|
||||
Options:
|
||||
description: "A list of internal resolver variables to be modified (e.g., `debug`, `ndots:3`, etc.)."
|
||||
type: "array"
|
||||
items:
|
||||
type: "string"
|
||||
Resources:
|
||||
description: "Resource requirements which apply to each individual container created as part of the service."
|
||||
type: "object"
|
||||
|
|
@ -2296,7 +2342,46 @@ definitions:
|
|||
type: "array"
|
||||
items:
|
||||
$ref: "#/definitions/Mount"
|
||||
|
||||
SecretSpec:
|
||||
type: "object"
|
||||
properties:
|
||||
Name:
|
||||
description: "User-defined name of the secret."
|
||||
type: "string"
|
||||
Labels:
|
||||
description: "User-defined key/value metadata."
|
||||
type: "object"
|
||||
additionalProperties:
|
||||
type: "string"
|
||||
Data:
|
||||
description: "Base64-url-safe-encoded secret data"
|
||||
type: "array"
|
||||
items:
|
||||
type: "string"
|
||||
Secret:
|
||||
type: "object"
|
||||
properties:
|
||||
ID:
|
||||
type: "string"
|
||||
Version:
|
||||
type: "object"
|
||||
properties:
|
||||
Index:
|
||||
type: "integer"
|
||||
format: "int64"
|
||||
CreatedAt:
|
||||
type: "string"
|
||||
format: "dateTime"
|
||||
UpdatedAt:
|
||||
type: "string"
|
||||
format: "dateTime"
|
||||
Spec:
|
||||
$ref: "#/definitions/ServiceSpec"
|
||||
Digest:
|
||||
type: "string"
|
||||
SecretSize:
|
||||
type: "integer"
|
||||
format: "int64"
|
||||
paths:
|
||||
/containers/json:
|
||||
get:
|
||||
|
|
@ -3651,7 +3736,7 @@ paths:
|
|||
|
||||
Either the `stream` or `logs` parameter must be `true` for this endpoint to do anything.
|
||||
|
||||
See [the documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/) for more details.
|
||||
See [the documentation for the `docker attach` command](/engine/reference/commandline/attach/) for more details.
|
||||
|
||||
### Hijacking
|
||||
|
||||
|
|
@ -4152,11 +4237,15 @@ paths:
|
|||
default: false
|
||||
- name: "filters"
|
||||
in: "query"
|
||||
description: "A JSON encoded value of the filters (a `map[string][]string`) to process on the containers list"
|
||||
type: "string"
|
||||
- name: "filter"
|
||||
in: "query"
|
||||
description: "Only return images with the specified name."
|
||||
description: |
|
||||
A JSON encoded value of the filters (a `map[string][]string`) to process on the images list.
|
||||
|
||||
Available filters:
|
||||
- `dangling=true`
|
||||
- `label=key` or `label="key=value"` of an image label
|
||||
- `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
|
||||
- `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
|
||||
- `reference`=(`<image-name>[:<tag>]`)
|
||||
type: "string"
|
||||
- name: "digests"
|
||||
in: "query"
|
||||
|
|
@ -4171,7 +4260,7 @@ paths:
|
|||
description: |
|
||||
Build an image from a tar archive with a `Dockerfile` in it.
|
||||
|
||||
The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/).
|
||||
The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](/engine/reference/builder/).
|
||||
|
||||
The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output.
|
||||
|
||||
|
|
@ -4255,7 +4344,7 @@ paths:
|
|||
type: "integer"
|
||||
- name: "buildargs"
|
||||
in: "query"
|
||||
description: "JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)"
|
||||
description: "JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. [Read more about the buildargs instruction.](/engine/reference/builder/#arg)"
|
||||
type: "integer"
|
||||
- name: "shmsize"
|
||||
in: "query"
|
||||
|
|
@ -6483,6 +6572,31 @@ paths:
|
|||
format: "binary"
|
||||
tags:
|
||||
- "Plugins"
|
||||
/plugins/{name}/push:
|
||||
post:
|
||||
summary: "Push a plugin"
|
||||
operationId: "PluginPush"
|
||||
description: |
|
||||
Push a plugin to the registry.
|
||||
parameters:
|
||||
- name: "name"
|
||||
in: "path"
|
||||
description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted."
|
||||
required: true
|
||||
type: "string"
|
||||
responses:
|
||||
200:
|
||||
description: "no error"
|
||||
404:
|
||||
description: "plugin not installed"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
500:
|
||||
description: "server error"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
tags:
|
||||
- "Plugins"
|
||||
/plugins/{name}/set:
|
||||
post:
|
||||
summary: "Configure a plugin"
|
||||
|
|
@ -6538,9 +6652,10 @@ paths:
|
|||
|
||||
Available filters:
|
||||
- `id=<node id>`
|
||||
- `label=<engine label>`
|
||||
- `membership=`(`accepted`|`pending`)`
|
||||
- `name=<node name>`
|
||||
- `membership=`(`pending`|`accepted`|`rejected`)`
|
||||
- `role=`(`worker`|`manager`)`
|
||||
- `role=`(`manager`|`worker`)`
|
||||
type: "string"
|
||||
tags:
|
||||
- "Nodes"
|
||||
|
|
@ -6564,7 +6679,7 @@ paths:
|
|||
parameters:
|
||||
- name: "id"
|
||||
in: "path"
|
||||
description: "The ID of the node"
|
||||
description: "The ID or name of the node"
|
||||
type: "string"
|
||||
required: true
|
||||
tags:
|
||||
|
|
@ -6586,7 +6701,7 @@ paths:
|
|||
parameters:
|
||||
- name: "id"
|
||||
in: "path"
|
||||
description: "The ID of the node"
|
||||
description: "The ID or name of the node"
|
||||
type: "string"
|
||||
required: true
|
||||
- name: "force"
|
||||
|
|
@ -6666,6 +6781,8 @@ paths:
|
|||
SnapshotInterval: 10000
|
||||
ElectionTick: 3
|
||||
TaskDefaults: {}
|
||||
EncryptionConfig:
|
||||
AutoLockManagers: false
|
||||
Name: "default"
|
||||
JoinTokens:
|
||||
Worker: "SWMTKN-1-1h8aps2yszaiqmz2l3oc5392pgk8e49qhx2aj3nyv0ui0hez2a-6qmn92w6bu3jdvnglku58u11a"
|
||||
|
|
@ -6733,6 +6850,8 @@ paths:
|
|||
Raft: {}
|
||||
Dispatcher: {}
|
||||
CAConfig: {}
|
||||
EncryptionConfig:
|
||||
AutoLockManagers: false
|
||||
tags:
|
||||
- "Swarm"
|
||||
/swarm/join:
|
||||
|
|
@ -6845,6 +6964,63 @@ paths:
|
|||
description: "Rotate the manager join token."
|
||||
type: "boolean"
|
||||
default: false
|
||||
- name: "rotateManagerUnlockKey"
|
||||
in: "query"
|
||||
description: "Rotate the manager unlock key."
|
||||
type: "boolean"
|
||||
default: false
|
||||
tags:
|
||||
- "Swarm"
|
||||
/swarm/unlockkey:
|
||||
get:
|
||||
summary: "Get the unlock key"
|
||||
operationId: "SwarmUnlockkey"
|
||||
consumes:
|
||||
- "application/json"
|
||||
responses:
|
||||
200:
|
||||
description: "no error"
|
||||
schema:
|
||||
type: "object"
|
||||
properties:
|
||||
UnlockKey:
|
||||
description: "The swarm's unlock key."
|
||||
type: "string"
|
||||
example:
|
||||
UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8"
|
||||
500:
|
||||
description: "server error"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
tags:
|
||||
- "Swarm"
|
||||
/swarm/unlock:
|
||||
post:
|
||||
summary: "Unlock a locked manager"
|
||||
operationId: "SwarmUnlock"
|
||||
consumes:
|
||||
- "application/json"
|
||||
produces:
|
||||
- "application/json"
|
||||
parameters:
|
||||
- name: "body"
|
||||
in: "body"
|
||||
required: true
|
||||
schema:
|
||||
type: "object"
|
||||
properties:
|
||||
UnlockKey:
|
||||
description: "The swarm's unlock key."
|
||||
type: "string"
|
||||
example:
|
||||
UnlockKey: "SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8"
|
||||
responses:
|
||||
200:
|
||||
description: "no error"
|
||||
500:
|
||||
description: "server error"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
tags:
|
||||
- "Swarm"
|
||||
/services:
|
||||
|
|
@ -6869,8 +7045,9 @@ paths:
|
|||
description: |
|
||||
A JSON encoded value of the filters (a `map[string][]string`) to process on the services list. Available filters:
|
||||
|
||||
- `id=<node id>`
|
||||
- `name=<node name>`
|
||||
- `id=<service id>`
|
||||
- `name=<service name>`
|
||||
- `label=<service label>`
|
||||
tags:
|
||||
- "Services"
|
||||
/services/create:
|
||||
|
|
@ -6932,6 +7109,10 @@ paths:
|
|||
Labels:
|
||||
com.example.something: "something-value"
|
||||
User: "33"
|
||||
DNSConfig:
|
||||
Nameservers: ["8.8.8.8"]
|
||||
Search: ["example.org"]
|
||||
Options: ["timeout:3"]
|
||||
LogDriver:
|
||||
Name: "json-file"
|
||||
Options:
|
||||
|
|
@ -7088,7 +7269,85 @@ paths:
|
|||
description: "A base64-encoded auth configuration for pulling from private registries. [See the authentication section for details.](#section/Authentication)"
|
||||
type: "string"
|
||||
|
||||
tags: [Service]
|
||||
tags: ["Services"]
|
||||
/services/{id}/logs:
|
||||
get:
|
||||
summary: "Get service logs"
|
||||
description: |
|
||||
Get `stdout` and `stderr` logs from a service.
|
||||
|
||||
**Note**: This endpoint works only for services with the `json-file` or `journald` logging drivers.
|
||||
operationId: "ServiceLogs"
|
||||
produces:
|
||||
- "application/vnd.docker.raw-stream"
|
||||
- "application/json"
|
||||
responses:
|
||||
101:
|
||||
description: "logs returned as a stream"
|
||||
schema:
|
||||
type: "string"
|
||||
format: "binary"
|
||||
200:
|
||||
description: "logs returned as a string in response body"
|
||||
schema:
|
||||
type: "string"
|
||||
404:
|
||||
description: "no such container"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
examples:
|
||||
application/json:
|
||||
message: "No such container: c2ada9df5af8"
|
||||
500:
|
||||
description: "server error"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
parameters:
|
||||
- name: "id"
|
||||
in: "path"
|
||||
required: true
|
||||
description: "ID or name of the container"
|
||||
type: "string"
|
||||
- name: "details"
|
||||
in: "query"
|
||||
description: "Show extra details provided to logs."
|
||||
type: "boolean"
|
||||
default: false
|
||||
- name: "follow"
|
||||
in: "query"
|
||||
description: |
|
||||
Return the logs as a stream.
|
||||
|
||||
This will return a `101` HTTP response with a `Connection: upgrade` header, then hijack the HTTP connection to send raw output. For more information about hijacking and the stream format, [see the documentation for the attach endpoint](#operation/PostContainerAttach).
|
||||
type: "boolean"
|
||||
default: false
|
||||
- name: "stdout"
|
||||
in: "query"
|
||||
description: "Return logs from `stdout`"
|
||||
type: "boolean"
|
||||
default: false
|
||||
- name: "stderr"
|
||||
in: "query"
|
||||
description: "Return logs from `stderr`"
|
||||
type: "boolean"
|
||||
default: false
|
||||
- name: "since"
|
||||
in: "query"
|
||||
description: "Only return logs since this time, as a UNIX timestamp"
|
||||
type: "integer"
|
||||
default: 0
|
||||
- name: "timestamps"
|
||||
in: "query"
|
||||
description: "Add timestamps to every log line"
|
||||
type: "boolean"
|
||||
default: false
|
||||
- name: "tail"
|
||||
in: "query"
|
||||
description: "Only return this number of log lines from the end of the logs. Specify as an integer or `all` to output all log lines."
|
||||
type: "string"
|
||||
default: "all"
|
||||
tags:
|
||||
- "Services"
|
||||
/tasks:
|
||||
get:
|
||||
summary: "List tasks"
|
||||
|
|
@ -7260,3 +7519,150 @@ paths:
|
|||
type: "string"
|
||||
tags:
|
||||
- "Tasks"
|
||||
/secrets:
|
||||
get:
|
||||
summary: "List secrets"
|
||||
operationId: "SecretList"
|
||||
produces:
|
||||
- "application/json"
|
||||
responses:
|
||||
200:
|
||||
description: "no error"
|
||||
schema:
|
||||
type: "array"
|
||||
items:
|
||||
$ref: "#/definitions/Secret"
|
||||
example:
|
||||
- ID: "ktnbjxoalbkvbvedmg1urrz8h"
|
||||
Version:
|
||||
Index: 11
|
||||
CreatedAt: "2016-11-05T01:20:17.327670065Z"
|
||||
UpdatedAt: "2016-11-05T01:20:17.327670065Z"
|
||||
Spec:
|
||||
Name: "app-dev.crt"
|
||||
Digest: "sha256:11d7c6f38253b73e608153c9f662a191ae605e1a3d9b756b0b3426388f91d3fa"
|
||||
SecretSize: 31
|
||||
500:
|
||||
description: "server error"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
parameters:
|
||||
- name: "filters"
|
||||
in: "query"
|
||||
type: "string"
|
||||
description: |
|
||||
A JSON encoded value of the filters (a `map[string][]string`) to process on the secrets list. Available filters:
|
||||
|
||||
- `names=<secret name>`
|
||||
tags:
|
||||
- "Secrets"
|
||||
/secrets/create:
|
||||
post:
|
||||
summary: "Create a secret"
|
||||
operationId: "SecretCreate"
|
||||
consumes:
|
||||
- "application/json"
|
||||
produces:
|
||||
- "application/json"
|
||||
responses:
|
||||
201:
|
||||
description: "no error"
|
||||
schema:
|
||||
type: "object"
|
||||
properties:
|
||||
ID:
|
||||
description: "The ID of the created secret."
|
||||
type: "string"
|
||||
example:
|
||||
ID: "ktnbjxoalbkvbvedmg1urrz8h"
|
||||
406:
|
||||
description: "server error or node is not part of a swarm"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
409:
|
||||
description: "name conflicts with an existing object"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
500:
|
||||
description: "server error"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
parameters:
|
||||
- name: "body"
|
||||
in: "body"
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: "#/definitions/SecretSpec"
|
||||
- type: "object"
|
||||
example:
|
||||
Name: "app-key.crt"
|
||||
Labels:
|
||||
foo: "bar"
|
||||
Data: "VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg=="
|
||||
tags:
|
||||
- "Secrets"
|
||||
/secrets/{id}:
|
||||
get:
|
||||
summary: "Inspect a secret"
|
||||
operationId: "SecretsInspect"
|
||||
produces:
|
||||
- "application/json"
|
||||
responses:
|
||||
200:
|
||||
description: "no error"
|
||||
schema:
|
||||
$ref: "#/definitions/Secret"
|
||||
example:
|
||||
ID: "ktnbjxoalbkvbvedmg1urrz8h"
|
||||
Version:
|
||||
Index: 11
|
||||
CreatedAt: "2016-11-05T01:20:17.327670065Z"
|
||||
UpdatedAt: "2016-11-05T01:20:17.327670065Z"
|
||||
Spec:
|
||||
Name: "app-dev.crt"
|
||||
Digest: "sha256:11d7c6f38253b73e608153c9f662a191ae605e1a3d9b756b0b3426388f91d3fa"
|
||||
SecretSize: 31
|
||||
404:
|
||||
description: "secret not found"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
406:
|
||||
description: "node is not part of a swarm"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
500:
|
||||
description: "server error"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
parameters:
|
||||
- name: "id"
|
||||
in: "path"
|
||||
required: true
|
||||
type: "string"
|
||||
description: "ID of the secret"
|
||||
tags:
|
||||
- "Secrets"
|
||||
delete:
|
||||
summary: "Delete a secret"
|
||||
operationId: "SecretsDelete"
|
||||
produces:
|
||||
- "application/json"
|
||||
responses:
|
||||
204:
|
||||
description: "no error"
|
||||
404:
|
||||
description: "secret not found"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
500:
|
||||
description: "server error"
|
||||
schema:
|
||||
$ref: "#/definitions/ErrorResponse"
|
||||
parameters:
|
||||
- name: "id"
|
||||
in: "path"
|
||||
required: true
|
||||
type: "string"
|
||||
description: "ID of the secret"
|
||||
tags:
|
||||
- "Secrets"
|
||||
|
|
|
|||
|
|
@ -356,7 +356,7 @@ type SecretRequestOption struct {
|
|||
Mode os.FileMode
|
||||
}
|
||||
|
||||
// SwarmUnlockKeyResponse contains the response for Remote API:
|
||||
// SwarmUnlockKeyResponse contains the response for Engine API:
|
||||
// GET /swarm/unlockkey
|
||||
type SwarmUnlockKeyResponse struct {
|
||||
// UnlockKey is the unlock key in ASCII-armored format.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ package types
|
|||
// This file was generated by the swagger tool.
|
||||
// Editing this file might prove futile when you re-run the swagger generate command
|
||||
|
||||
// Plugin A plugin for the Remote API
|
||||
// Plugin A plugin for the Engine API
|
||||
// swagger:model Plugin
|
||||
type Plugin struct {
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ import (
|
|||
"fmt"
|
||||
)
|
||||
|
||||
// PluginsListResponse contains the response for the remote API
|
||||
// PluginsListResponse contains the response for the Engine API
|
||||
type PluginsListResponse []*Plugin
|
||||
|
||||
const (
|
||||
|
|
|
|||
|
|
@ -17,14 +17,14 @@ import (
|
|||
"github.com/docker/go-connections/nat"
|
||||
)
|
||||
|
||||
// ContainerChange contains response of Remote API:
|
||||
// ContainerChange contains response of Engine API:
|
||||
// GET "/containers/{name:.*}/changes"
|
||||
type ContainerChange struct {
|
||||
Kind int
|
||||
Path string
|
||||
}
|
||||
|
||||
// ImageHistory contains response of Remote API:
|
||||
// ImageHistory contains response of Engine API:
|
||||
// GET "/images/{name:.*}/history"
|
||||
type ImageHistory struct {
|
||||
ID string `json:"Id"`
|
||||
|
|
@ -35,7 +35,7 @@ type ImageHistory struct {
|
|||
Comment string
|
||||
}
|
||||
|
||||
// ImageDelete contains response of Remote API:
|
||||
// ImageDelete contains response of Engine API:
|
||||
// DELETE "/images/{name:.*}"
|
||||
type ImageDelete struct {
|
||||
Untagged string `json:",omitempty"`
|
||||
|
|
@ -56,7 +56,7 @@ type RootFS struct {
|
|||
BaseLayer string `json:",omitempty"`
|
||||
}
|
||||
|
||||
// ImageInspect contains response of Remote API:
|
||||
// ImageInspect contains response of Engine API:
|
||||
// GET "/images/{name:.*}/json"
|
||||
type ImageInspect struct {
|
||||
ID string `json:"Id"`
|
||||
|
|
@ -79,7 +79,7 @@ type ImageInspect struct {
|
|||
RootFS RootFS
|
||||
}
|
||||
|
||||
// Container contains response of Remote API:
|
||||
// Container contains response of Engine API:
|
||||
// GET "/containers/json"
|
||||
type Container struct {
|
||||
ID string `json:"Id"`
|
||||
|
|
@ -101,7 +101,7 @@ type Container struct {
|
|||
Mounts []MountPoint
|
||||
}
|
||||
|
||||
// CopyConfig contains request body of Remote API:
|
||||
// CopyConfig contains request body of Engine API:
|
||||
// POST "/containers/"+containerID+"/copy"
|
||||
type CopyConfig struct {
|
||||
Resource string
|
||||
|
|
@ -118,28 +118,28 @@ type ContainerPathStat struct {
|
|||
LinkTarget string `json:"linkTarget"`
|
||||
}
|
||||
|
||||
// ContainerStats contains response of Remote API:
|
||||
// ContainerStats contains response of Engine API:
|
||||
// GET "/stats"
|
||||
type ContainerStats struct {
|
||||
Body io.ReadCloser `json:"body"`
|
||||
OSType string `json:"ostype"`
|
||||
}
|
||||
|
||||
// ContainerProcessList contains response of Remote API:
|
||||
// ContainerProcessList contains response of Engine API:
|
||||
// GET "/containers/{name:.*}/top"
|
||||
type ContainerProcessList struct {
|
||||
Processes [][]string
|
||||
Titles []string
|
||||
}
|
||||
|
||||
// Ping contains response of Remote API:
|
||||
// Ping contains response of Engine API:
|
||||
// GET "/_ping"
|
||||
type Ping struct {
|
||||
APIVersion string
|
||||
Experimental bool
|
||||
}
|
||||
|
||||
// Version contains response of Remote API:
|
||||
// Version contains response of Engine API:
|
||||
// GET "/version"
|
||||
type Version struct {
|
||||
Version string
|
||||
|
|
@ -161,7 +161,7 @@ type Commit struct {
|
|||
Expected string
|
||||
}
|
||||
|
||||
// Info contains response of Remote API:
|
||||
// Info contains response of Engine API:
|
||||
// GET "/info"
|
||||
type Info struct {
|
||||
ID string
|
||||
|
|
@ -339,7 +339,7 @@ type ContainerNode struct {
|
|||
Labels map[string]string
|
||||
}
|
||||
|
||||
// ContainerJSONBase contains response of Remote API:
|
||||
// ContainerJSONBase contains response of Engine API:
|
||||
// GET "/containers/{name:.*}/json"
|
||||
type ContainerJSONBase struct {
|
||||
ID string `json:"Id"`
|
||||
|
|
@ -500,7 +500,7 @@ type Runtime struct {
|
|||
Args []string `json:"runtimeArgs,omitempty"`
|
||||
}
|
||||
|
||||
// DiskUsage contains response of Remote API:
|
||||
// DiskUsage contains response of Engine API:
|
||||
// GET "/system/df"
|
||||
type DiskUsage struct {
|
||||
LayersSize int64
|
||||
|
|
@ -509,49 +509,49 @@ type DiskUsage struct {
|
|||
Volumes []*Volume
|
||||
}
|
||||
|
||||
// ImagesPruneConfig contains the configuration for Remote API:
|
||||
// ImagesPruneConfig contains the configuration for Engine API:
|
||||
// POST "/images/prune"
|
||||
type ImagesPruneConfig struct {
|
||||
DanglingOnly bool
|
||||
}
|
||||
|
||||
// ContainersPruneConfig contains the configuration for Remote API:
|
||||
// ContainersPruneConfig contains the configuration for Engine API:
|
||||
// POST "/images/prune"
|
||||
type ContainersPruneConfig struct {
|
||||
}
|
||||
|
||||
// VolumesPruneConfig contains the configuration for Remote API:
|
||||
// VolumesPruneConfig contains the configuration for Engine API:
|
||||
// POST "/images/prune"
|
||||
type VolumesPruneConfig struct {
|
||||
}
|
||||
|
||||
// NetworksPruneConfig contains the configuration for Remote API:
|
||||
// NetworksPruneConfig contains the configuration for Engine API:
|
||||
// POST "/networks/prune"
|
||||
type NetworksPruneConfig struct {
|
||||
}
|
||||
|
||||
// ContainersPruneReport contains the response for Remote API:
|
||||
// ContainersPruneReport contains the response for Engine API:
|
||||
// POST "/containers/prune"
|
||||
type ContainersPruneReport struct {
|
||||
ContainersDeleted []string
|
||||
SpaceReclaimed uint64
|
||||
}
|
||||
|
||||
// VolumesPruneReport contains the response for Remote API:
|
||||
// VolumesPruneReport contains the response for Engine API:
|
||||
// POST "/volumes/prune"
|
||||
type VolumesPruneReport struct {
|
||||
VolumesDeleted []string
|
||||
SpaceReclaimed uint64
|
||||
}
|
||||
|
||||
// ImagesPruneReport contains the response for Remote API:
|
||||
// ImagesPruneReport contains the response for Engine API:
|
||||
// POST "/images/prune"
|
||||
type ImagesPruneReport struct {
|
||||
ImagesDeleted []ImageDelete
|
||||
SpaceReclaimed uint64
|
||||
}
|
||||
|
||||
// NetworksPruneReport contains the response for Remote API:
|
||||
// NetworksPruneReport contains the response for Engine API:
|
||||
// POST "/networks/prune"
|
||||
type NetworksPruneReport struct {
|
||||
NetworksDeleted []string
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Go client for the Docker Remote API
|
||||
# Go client for the Docker Engine API
|
||||
|
||||
The `docker` command uses this package to communicate with the daemon. It can also be used by your own Go applications to do anything the command-line interface does – running containers, pulling images, managing swarms, etc.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
/*
|
||||
Package client is a Go client for the Docker Remote API.
|
||||
Package client is a Go client for the Docker Engine API.
|
||||
|
||||
The "docker" command uses this package to communicate with the daemon. It can also
|
||||
be used by your own Go applications to do anything the command-line interface does
|
||||
- running containers, pulling images, managing swarms, etc.
|
||||
|
||||
For more information about the Remote API, see the documentation:
|
||||
https://docs.docker.com/engine/reference/api/docker_remote_api/
|
||||
For more information about the Engine API, see the documentation:
|
||||
https://docs.docker.com/engine/reference/api/
|
||||
|
||||
Usage
|
||||
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ func (DetachError) Error() string {
|
|||
type CommonContainer struct {
|
||||
StreamConfig *stream.Config
|
||||
// embed for Container to support states directly.
|
||||
*State `json:"State"` // Needed for remote api version <= 1.11
|
||||
*State `json:"State"` // Needed for Engine API version <= 1.11
|
||||
Root string `json:"-"` // Path to the "home" of the container, including metadata.
|
||||
BaseFS string `json:"-"` // Path to the graphdriver mountpoint
|
||||
RWLayer layer.RWLayer `json:"-"`
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ function __fish_print_docker_repositories --description 'Print a list of docker
|
|||
end
|
||||
|
||||
# common options
|
||||
complete -c docker -f -n '__fish_docker_no_subcommand' -l api-cors-header -d "Set CORS headers in the remote API. Default is cors disabled"
|
||||
complete -c docker -f -n '__fish_docker_no_subcommand' -l api-cors-header -d "Set CORS headers in the Engine API. Default is cors disabled"
|
||||
complete -c docker -f -n '__fish_docker_no_subcommand' -s b -l bridge -d 'Attach containers to a pre-existing network bridge'
|
||||
complete -c docker -f -n '__fish_docker_no_subcommand' -l bip -d "Use this CIDR notation address for the network bridge's IP, not compatible with -b"
|
||||
complete -c docker -f -n '__fish_docker_no_subcommand' -s D -l debug -d 'Enable debug mode'
|
||||
|
|
|
|||
|
|
@ -2200,7 +2200,7 @@ __docker_subcommand() {
|
|||
_arguments $(__docker_arguments) \
|
||||
$opts_help \
|
||||
"($help)*--add-runtime=[Register an additional OCI compatible runtime]:runtime:__docker_complete_runtimes" \
|
||||
"($help)--api-cors-header=[CORS headers in the remote API]:CORS headers: " \
|
||||
"($help)--api-cors-header=[CORS headers in the Engine API]:CORS headers: " \
|
||||
"($help)*--authorization-plugin=[Authorization plugins to load]" \
|
||||
"($help -b --bridge)"{-b=,--bridge=}"[Attach containers to a network bridge]:bridge:_net_interfaces" \
|
||||
"($help)--bip=[Network bridge IP]:IP address: " \
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ meaning you can use Vagrant to control Docker containers.
|
|||
* [docker-provider](https://github.com/fgrehm/docker-provider)
|
||||
* [vagrant-shell](https://github.com/destructuring/vagrant-shell)
|
||||
|
||||
## Setting up Vagrant-docker with the Remote API
|
||||
## Setting up Vagrant-docker with the Engine API
|
||||
|
||||
The initial Docker upstart script will not work because it runs on `127.0.0.1`, which is not accessible to the host machine. Instead, we need to change the script to connect to `0.0.0.0`. To do this, modify `/etc/init/docker.conf` to look like this:
|
||||
|
||||
|
|
|
|||
|
|
@ -185,7 +185,7 @@ func (config *Config) InstallCommonFlags(flags *pflag.FlagSet) {
|
|||
flags.StringVar(&config.ClusterAdvertise, "cluster-advertise", "", "Address or interface name to advertise")
|
||||
flags.StringVar(&config.ClusterStore, "cluster-store", "", "URL of the distributed storage backend")
|
||||
flags.Var(opts.NewNamedMapOpts("cluster-store-opts", config.ClusterOpts, nil), "cluster-store-opt", "Set cluster store options")
|
||||
flags.StringVar(&config.CorsHeaders, "api-cors-header", "", "Set CORS headers in the remote API")
|
||||
flags.StringVar(&config.CorsHeaders, "api-cors-header", "", "Set CORS headers in the Engine API")
|
||||
flags.IntVar(&maxConcurrentDownloads, "max-concurrent-downloads", defaultMaxConcurrentDownloads, "Set the max concurrent downloads for each pull")
|
||||
flags.IntVar(&maxConcurrentUploads, "max-concurrent-uploads", defaultMaxConcurrentUploads, "Set the max concurrent uploads for each push")
|
||||
flags.IntVar(&config.ShutdownTimeout, "shutdown-timeout", defaultShutdownTimeout, "Set the default shutdown timeout")
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ func (config *Config) InstallFlags(flags *pflag.FlagSet) {
|
|||
flags.StringVar(&config.bridgeConfig.FixedCIDRv6, "fixed-cidr-v6", "", "IPv6 subnet for fixed IPs")
|
||||
flags.BoolVar(&config.bridgeConfig.EnableUserlandProxy, "userland-proxy", true, "Use userland proxy for loopback traffic")
|
||||
flags.StringVar(&config.bridgeConfig.UserlandProxyPath, "userland-proxy-path", "", "Path to the userland proxy binary")
|
||||
flags.BoolVar(&config.EnableCors, "api-enable-cors", false, "Enable CORS headers in the remote API, this is deprecated by --api-cors-header")
|
||||
flags.BoolVar(&config.EnableCors, "api-enable-cors", false, "Enable CORS headers in the Engine API, this is deprecated by --api-cors-header")
|
||||
flags.MarkDeprecated("api-enable-cors", "Please use --api-cors-header")
|
||||
flags.StringVar(&config.CgroupParent, "cgroup-parent", "", "Set parent cgroup for all containers")
|
||||
flags.StringVar(&config.RemappedRoot, "userns-remap", "", "User/Group setting for user namespaces")
|
||||
|
|
|
|||
|
|
@ -226,7 +226,7 @@ func (daemon *Daemon) setRWLayer(container *container.Container) error {
|
|||
}
|
||||
|
||||
// VolumeCreate creates a volume with the specified name, driver, and opts
|
||||
// This is called directly from the remote API
|
||||
// This is called directly from the Engine API
|
||||
func (daemon *Daemon) VolumeCreate(name, driverName string, opts, labels map[string]string) (*types.Volume, error) {
|
||||
if name == "" {
|
||||
name = stringid.GenerateNonCryptoID()
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@ func (daemon *Daemon) cleanupContainer(container *container.Container, forceRemo
|
|||
|
||||
// VolumeRm removes the volume with the given name.
|
||||
// If the volume is referenced by a container it is not removed
|
||||
// This is called directly from the remote API
|
||||
// This is called directly from the Engine API
|
||||
func (daemon *Daemon) VolumeRm(name string, force bool) error {
|
||||
err := daemon.volumeRm(name)
|
||||
if err == nil || force {
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ const termProcessTimeout = 10
|
|||
func (d *Daemon) registerExecCommand(container *container.Container, config *exec.Config) {
|
||||
// Storing execs in container in order to kill them gracefully whenever the container is stopped or removed.
|
||||
container.ExecCommands.Add(config.ID, config)
|
||||
// Storing execs in daemon for easy access via remote API.
|
||||
// Storing execs in daemon for easy access via Engine API.
|
||||
d.execCommands.Add(config.ID, config)
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ func (daemon *Daemon) ContainerStats(ctx context.Context, prefixOrName string, c
|
|||
if runtime.GOOS == "solaris" {
|
||||
return fmt.Errorf("%+v does not support stats", runtime.GOOS)
|
||||
}
|
||||
// Remote API version (used for backwards compatibility)
|
||||
// Engine API version (used for backwards compatibility)
|
||||
apiVersion := config.Version
|
||||
|
||||
container, err := daemon.GetContainer(prefixOrName)
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ var (
|
|||
|
||||
type mounts []container.Mount
|
||||
|
||||
// volumeToAPIType converts a volume.Volume to the type used by the remote API
|
||||
// volumeToAPIType converts a volume.Volume to the type used by the Engine API
|
||||
func volumeToAPIType(v volume.Volume) *types.Volume {
|
||||
tv := &types.Volume{
|
||||
Name: v.Name(),
|
||||
|
|
|
|||
|
|
@ -1,7 +1,10 @@
|
|||
---
|
||||
title: "Remote API v1.18"
|
||||
title: "Engine 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
|
||||
|
|
@ -13,11 +16,10 @@ keywords: "API, Docker, rcli, REST, documentation"
|
|||
will be rejected.
|
||||
-->
|
||||
|
||||
# Docker Remote API v1.18
|
||||
# Docker Engine API v1.18
|
||||
|
||||
# 1. Brief introduction
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
|
||||
- The API tends to be REST, but for some complex commands, like `attach`
|
||||
|
|
@ -2148,7 +2150,7 @@ This might change in the future.
|
|||
|
||||
## 3.3 CORS Requests
|
||||
|
||||
To set cross origin requests to the remote api please give values to
|
||||
To set cross origin requests to the Engine API please give values to
|
||||
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
|
||||
default or blank means CORS disabled
|
||||
|
||||
|
|
@ -1,7 +1,10 @@
|
|||
---
|
||||
title: "Remote API v1.19"
|
||||
title: "Engine 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
|
||||
|
|
@ -13,11 +16,10 @@ keywords: "API, Docker, rcli, REST, documentation"
|
|||
will be rejected.
|
||||
-->
|
||||
|
||||
# Docker Remote API v1.19
|
||||
# Docker Engine API v1.19
|
||||
|
||||
## 1. Brief introduction
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
|
||||
- The API tends to be REST. However, for some complex commands, like `attach`
|
||||
|
|
@ -2230,7 +2232,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
|
|||
|
||||
## 3.3 CORS Requests
|
||||
|
||||
To set cross origin requests to the remote api please give values to
|
||||
To set cross origin requests to the Engine API please give values to
|
||||
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
|
||||
default or blank means CORS disabled
|
||||
|
||||
|
|
@ -1,7 +1,10 @@
|
|||
---
|
||||
title: "Remote API v1.20"
|
||||
title: "Engine 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
|
||||
|
|
@ -13,11 +16,10 @@ keywords: "API, Docker, rcli, REST, documentation"
|
|||
will be rejected.
|
||||
-->
|
||||
|
||||
# Docker Remote API v1.20
|
||||
# Docker Engine API v1.20
|
||||
|
||||
# 1. Brief introduction
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
|
||||
- The API tends to be REST. However, for some complex commands, like `attach`
|
||||
|
|
@ -2383,7 +2385,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
|
|||
|
||||
## 3.3 CORS Requests
|
||||
|
||||
To set cross origin requests to the remote api please give values to
|
||||
To set cross origin requests to the Engine API please give values to
|
||||
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
|
||||
default or blank means CORS disabled
|
||||
|
||||
|
|
@ -1,7 +1,10 @@
|
|||
---
|
||||
title: "Remote API v1.21"
|
||||
title: "Engine 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
|
||||
|
|
@ -13,11 +16,10 @@ keywords: "API, Docker, rcli, REST, documentation"
|
|||
will be rejected.
|
||||
-->
|
||||
|
||||
# Docker Remote API v1.21
|
||||
# Docker Engine API v1.21
|
||||
|
||||
## 1. Brief introduction
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
|
||||
- The API tends to be REST. However, for some complex commands, like `attach`
|
||||
|
|
@ -2961,7 +2963,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
|
|||
|
||||
## 3.3 CORS Requests
|
||||
|
||||
To set cross origin requests to the remote api please give values to
|
||||
To set cross origin requests to the Engine API please give values to
|
||||
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
|
||||
default or blank means CORS disabled
|
||||
|
||||
|
|
@ -1,7 +1,10 @@
|
|||
---
|
||||
title: "Remote API v1.22"
|
||||
title: "Engine 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
|
||||
|
|
@ -13,11 +16,10 @@ keywords: "API, Docker, rcli, REST, documentation"
|
|||
will be rejected.
|
||||
-->
|
||||
|
||||
# Docker Remote API v1.22
|
||||
# Docker Engine API v1.22
|
||||
|
||||
# 1. Brief introduction
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
|
||||
- The API tends to be REST. However, for some complex commands, like `attach`
|
||||
|
|
@ -3299,7 +3301,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
|
|||
|
||||
## 3.3 CORS Requests
|
||||
|
||||
To set cross origin requests to the remote api please give values to
|
||||
To set cross origin requests to the Engine API please give values to
|
||||
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
|
||||
default or blank means CORS disabled
|
||||
|
||||
|
|
@ -1,7 +1,10 @@
|
|||
---
|
||||
title: "Remote API v1.23"
|
||||
title: "Engine 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
|
||||
|
|
@ -13,11 +16,10 @@ keywords: "API, Docker, rcli, REST, documentation"
|
|||
will be rejected.
|
||||
-->
|
||||
|
||||
# Docker Remote API v1.23
|
||||
# Docker Engine API v1.23
|
||||
|
||||
## 1. Brief introduction
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
|
||||
- The API tends to be REST. However, for some complex commands, like `attach`
|
||||
|
|
@ -3416,7 +3418,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
|
|||
|
||||
## 3.3 CORS Requests
|
||||
|
||||
To set cross origin requests to the remote api please give values to
|
||||
To set cross origin requests to the Engine API please give values to
|
||||
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
|
||||
default or blank means CORS disabled
|
||||
|
||||
|
|
@ -1,7 +1,10 @@
|
|||
---
|
||||
title: "Remote API v1.24"
|
||||
title: "Engine 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
|
||||
|
|
@ -13,11 +16,10 @@ keywords: "API, Docker, rcli, REST, documentation"
|
|||
will be rejected.
|
||||
-->
|
||||
|
||||
# Docker Remote API v1.24
|
||||
# Docker Engine API v1.24
|
||||
|
||||
# 1. Brief introduction
|
||||
|
||||
- The Remote API has replaced `rcli`.
|
||||
- The daemon listens on `unix:///var/run/docker.sock` but you can
|
||||
[Bind Docker to another host/port or a Unix socket](../commandline/dockerd.md#bind-docker-to-another-host-port-or-a-unix-socket).
|
||||
- The API tends to be REST. However, for some complex commands, like `attach`
|
||||
|
|
@ -26,7 +28,7 @@ keywords: "API, Docker, rcli, REST, documentation"
|
|||
|
||||
# 2. Errors
|
||||
|
||||
The Remote API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:
|
||||
The Engine API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:
|
||||
|
||||
{
|
||||
"message": "page not found"
|
||||
|
|
@ -5274,7 +5276,7 @@ from **200 OK** to **101 UPGRADED** and resends the same headers.
|
|||
|
||||
## 4.3 CORS Requests
|
||||
|
||||
To set cross origin requests to the remote api please give values to
|
||||
To set cross origin requests to the Engine API please give values to
|
||||
`--api-cors-header` when running Docker in daemon mode. Set * (asterisk) allows all,
|
||||
default or blank means CORS disabled
|
||||
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Remote API"
|
||||
description: "API Documentation for Docker"
|
||||
title: "Engine API version history"
|
||||
description: "Documentation of changes that have been made to Engine API."
|
||||
keywords: "API, Docker, rcli, REST, documentation"
|
||||
---
|
||||
|
||||
|
|
@ -13,139 +13,13 @@ keywords: "API, Docker, rcli, REST, documentation"
|
|||
will be rejected.
|
||||
-->
|
||||
|
||||
# Docker Remote API
|
||||
## v1.26 API changes
|
||||
|
||||
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.
|
||||
[Docker Engine API v1.26](v1.26/) documentation
|
||||
|
||||
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.
|
||||
## v1.25 API changes
|
||||
|
||||
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
|
||||
|
||||
[Docker Remote API v1.26](docker_remote_api_v1.26.md) documentation
|
||||
|
||||
|
||||
### v1.25 API changes
|
||||
|
||||
[Docker Remote API v1.25](docker_remote_api_v1.25.md) documentation
|
||||
[Docker Engine API v1.25](v1.25.md) documentation
|
||||
|
||||
* The API version is now required in all API calls. Instead of just requesting, for example, the URL `/containers/json`, you must now request `/v1.25/containers/json`.
|
||||
* `GET /version` now returns `MinAPIVersion`.
|
||||
|
|
@ -204,9 +78,9 @@ 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
|
||||
[Docker Engine API v1.24](v1.24.md) documentation
|
||||
|
||||
* `POST /containers/create` now takes `StorageOpt` field.
|
||||
* `GET /info` now returns `SecurityOptions` field, showing if `apparmor`, `seccomp`, or `selinux` is supported.
|
||||
|
|
@ -236,9 +110,9 @@ 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
|
||||
[Docker Engine API v1.23](v1.23.md) documentation
|
||||
|
||||
* `GET /containers/json` returns the state of the container, one of `created`, `restarting`, `running`, `paused`, `exited` or `dead`.
|
||||
* `GET /containers/json` returns the mount points for the container.
|
||||
|
|
@ -258,9 +132,9 @@ 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
|
||||
[Docker Engine API v1.22](v1.22.md) documentation
|
||||
|
||||
* `POST /container/(name)/update` updates the resources of a container.
|
||||
* `GET /containers/json` supports filter `isolation` on Windows.
|
||||
|
|
@ -292,9 +166,9 @@ 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
|
||||
[Docker Engine API v1.21](v1.21.md) documentation
|
||||
|
||||
* `GET /volumes` lists volumes from all volume drivers.
|
||||
* `POST /volumes/create` to create a volume.
|
||||
|
|
@ -327,9 +201,9 @@ 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
|
||||
[Docker Engine API v1.20](v1.20.md) documentation
|
||||
|
||||
* `GET /containers/(id)/archive` get an archive of filesystem content from a container.
|
||||
* `PUT /containers/(id)/archive` upload an archive of content to be extracted to
|
||||
|
|
@ -339,9 +213,9 @@ 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
|
||||
[Docker Engine API v1.19](v1.19.md) documentation
|
||||
|
||||
* When the daemon detects a version mismatch with the client, usually when
|
||||
the client is newer than the daemon, an HTTP 400 is now returned instead
|
||||
|
|
@ -355,9 +229,9 @@ 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
|
||||
[Docker Engine API v1.18](v1.18.md) documentation
|
||||
|
||||
* `GET /version` now returns `Os`, `Arch` and `KernelVersion`.
|
||||
* `POST /containers/create` and `POST /containers/(id)/start`allow you to set ulimit settings for use in the container.
|
||||
|
|
@ -22,7 +22,7 @@ refer to [Docker Engine plugin system](index.md).
|
|||
|
||||
Docker's out-of-the-box authorization model is all or nothing. Any user with
|
||||
permission to access the Docker daemon can run any Docker client command. The
|
||||
same is true for callers using Docker's remote API to contact the daemon. If you
|
||||
same is true for callers using Docker's Engine API to contact the daemon. If you
|
||||
require greater access control, you can create authorization plugins and add
|
||||
them to your Docker daemon configuration. Using an authorization plugin, a
|
||||
Docker administrator can configure granular access policies for managing access
|
||||
|
|
@ -69,7 +69,7 @@ can be ordered. Each request to the daemon passes in order through the chain.
|
|||
Only when all the plugins grant access to the resource, is the access granted.
|
||||
|
||||
When an HTTP request is made to the Docker daemon through the CLI or via the
|
||||
remote API, the authentication subsystem passes the request to the installed
|
||||
Engine API, the authentication subsystem passes the request to the installed
|
||||
authentication plugin(s). The request contains the user (caller) and command
|
||||
context. The plugin is responsible for deciding whether to allow or deny the
|
||||
request.
|
||||
|
|
|
|||
|
|
@ -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>
|
||||
|
|
@ -24,7 +24,7 @@ A self-sufficient runtime for containers.
|
|||
Options:
|
||||
|
||||
--add-runtime value Register an additional OCI compatible runtime (default [])
|
||||
--api-cors-header string Set CORS headers in the remote API
|
||||
--api-cors-header string Set CORS headers in the Engine API
|
||||
--authorization-plugin value Authorization plugins to load (default [])
|
||||
--bip string Specify network bridge IP
|
||||
-b, --bridge string Attach containers to a network bridge
|
||||
|
|
@ -101,7 +101,7 @@ To run the daemon with debug output, use `dockerd -D`.
|
|||
|
||||
## Daemon socket option
|
||||
|
||||
The Docker daemon can listen for [Docker Remote API](../api/docker_remote_api.md)
|
||||
The Docker daemon can listen for [Docker Engine API](../api/)
|
||||
requests via three different types of Socket: `unix`, `tcp`, and `fd`.
|
||||
|
||||
By default, a `unix` domain socket (or IPC socket) is created at
|
||||
|
|
@ -905,7 +905,7 @@ path. Consult with your Docker administrator to get information about the
|
|||
plugins available to you.
|
||||
|
||||
Once a plugin is installed, requests made to the `daemon` through the command
|
||||
line or Docker's remote API are allowed or denied by the plugin. If you have
|
||||
line or Docker's Engine API are allowed or denied by the plugin. If you have
|
||||
multiple plugins installed, at least one must allow the request for it to
|
||||
complete.
|
||||
|
||||
|
|
@ -1094,11 +1094,11 @@ the `--cgroup-parent` option on the daemon.
|
|||
## Daemon Metrics
|
||||
|
||||
The `--metrics-addr` option takes a tcp address to serve the metrics API.
|
||||
This feature is still experimental, therefore, the daemon must be running in experimental
|
||||
This feature is still experimental, therefore, the daemon must be running in experimental
|
||||
mode for this feature to work.
|
||||
|
||||
To serve the metrics API on localhost:1337 you would specify `--metrics-addr 127.0.0.1:1337`
|
||||
allowing you to make requests on the API at `127.0.0.1:1337/metrics` to receive metrics in the
|
||||
allowing you to make requests on the API at `127.0.0.1:1337/metrics` to receive metrics in the
|
||||
[prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/) format.
|
||||
|
||||
If you are running a prometheus server you can add this address to your scrape configs
|
||||
|
|
@ -1113,7 +1113,7 @@ scrape_configs:
|
|||
```
|
||||
|
||||
Please note that this feature is still marked as experimental as metrics and metric
|
||||
names could change while this feature is still in experimental. Please provide
|
||||
names could change while this feature is still in experimental. Please provide
|
||||
feedback on what you would like to see collected in the API.
|
||||
|
||||
## Daemon configuration file
|
||||
|
|
|
|||
|
|
@ -303,7 +303,7 @@ func (s *DockerSuite) TestAPIStatsNoStreamConnectedContainers(c *check.C) {
|
|||
|
||||
select {
|
||||
case err := <-ch:
|
||||
c.Assert(err, checker.IsNil, check.Commentf("Error in stats remote API: %v", err))
|
||||
c.Assert(err, checker.IsNil, check.Commentf("Error in stats Engine API: %v", err))
|
||||
case <-time.After(15 * time.Second):
|
||||
c.Fatalf("Stats did not return after timeout")
|
||||
}
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ following format.
|
|||
Set additional OCI compatible runtime.
|
||||
|
||||
**--api-cors-header**=""
|
||||
Set CORS headers in the remote API. Default is cors disabled. Give urls like
|
||||
Set CORS headers in the Engine API. Default is cors disabled. Give urls like
|
||||
"http://foo, http://bar, ...". Give "*" to allow all.
|
||||
|
||||
**--authorization-plugin**=""
|
||||
|
|
@ -664,7 +664,7 @@ specify a name or path. Consult with your Docker administrator to get
|
|||
information about the plugins available to you.
|
||||
|
||||
Once a plugin is installed, requests made to the `daemon` through the command
|
||||
line or Docker's remote API are allowed or denied by the plugin. If you have
|
||||
line or Docker's Engine API are allowed or denied by the plugin. If you have
|
||||
multiple plugins installed, at least one must allow the request for it to
|
||||
complete.
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ const maxBodySize = 1048576 // 1MB
|
|||
// Authenticate Request:
|
||||
// Call authZ plugins with current REST request and AuthN response
|
||||
// Request contains full HTTP packet sent to the docker daemon
|
||||
// https://docs.docker.com/engine/reference/api/docker_remote_api/
|
||||
// https://docs.docker.com/engine/reference/api/
|
||||
//
|
||||
// Authenticate Response:
|
||||
// Call authZ plugins with full info about current REST request, REST response and AuthN response
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@ If releasing a major version (X or Y increased in vX.Y.Z), simply listing notabl
|
|||
```markdown
|
||||
#### Notable features since <last major version>
|
||||
* New docker command to do something useful
|
||||
* Remote API change (deprecating old version)
|
||||
* Engine API change (deprecating old version)
|
||||
* Performance improvements in some usecases
|
||||
* ...
|
||||
```
|
||||
|
|
@ -131,7 +131,7 @@ Each change should be listed under a category heading formatted as `#### CATEGOR
|
|||
* Documentation
|
||||
* Hack
|
||||
* Packaging
|
||||
* Remote API
|
||||
* Engine API
|
||||
* Runtime
|
||||
* Other (please use this category sparingly)
|
||||
|
||||
|
|
@ -154,7 +154,7 @@ EXAMPLES:
|
|||
|
||||
+ 'docker build -t FOO .' applies the tag FOO to the newly built image
|
||||
|
||||
#### Remote API
|
||||
#### Engine API
|
||||
|
||||
- Fix a bug in the optional unix socket transport
|
||||
|
||||
|
|
|
|||
|
|
@ -181,7 +181,7 @@ Possible transitions from this state:
|
|||
After merging a pull request, the maintainer should consider applying one or multiple impact labels
|
||||
to ease future classification:
|
||||
|
||||
* `impact/api` signifies the patch impacted the remote API
|
||||
* `impact/api` signifies the patch impacted the Engine API
|
||||
* `impact/changelog` signifies the change is significant enough to make it in the changelog
|
||||
* `impact/cli` signifies the patch impacted a CLI command
|
||||
* `impact/dockerfile` signifies the patch impacted the Dockerfile syntax
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue