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. # Errors 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: ``` { "message": "page not found" } ``` # Versioning The API is usually changed in each release of Docker, so API calls are versioned to ensure that clients don't break. For Docker Engine 17.09, the API version is 1.32. To lock to this version, you prefix the URL with `/v1.32`. For example, calling `/info` is the same as calling `/v1.32/info`. Engine releases in the near future should support this version of the API, so your client will continue
/v1.33104 endpoints available
/authCheck auth configuration
/infoGet system information
/_pingPing
/buildBuild an image
/nodesList nodes
/swarmInspect swarm
/tasksList tasks
/commitCreate a new image from a container
/eventsMonitor events
/configsList configs
/pluginsList plugins
/secretsList secrets
/sessionInitialize interactive session
/versionGet version
/volumesList volumes
/networksList networks
/servicesList services
/system/dfGet data usage information
/images/getExport several images
/nodes/{id}Inspect a node
/nodes/{id}Delete a node
/swarm/initInitialize a new swarm
/swarm/joinJoin an existing swarm
/tasks/{id}Inspect a task
/build/pruneDelete builder cache
/images/jsonList Images
/images/loadImport images
/swarm/leaveLeave a swarm
/configs/{id}Inspect a config
/configs/{id}Delete a config
/images/pruneDelete unused images
/plugins/pullInstall a plugin
/secrets/{id}Inspect a secret
/secrets/{id}Delete a secret
/swarm/unlockUnlock a locked manager
/swarm/updateUpdate a swarm
/images/createCreate an image
/images/searchSearch images
/images/{name}Remove an image
/networks/{id}Inspect a network
/networks/{id}Remove a network
/services/{id}Inspect a service
/services/{id}Delete a service
/volumes/pruneDelete unused volumes
/configs/createCreate a config
/exec/{id}/jsonInspect an exec instance
/networks/pruneDelete unused networks
/plugins/createCreate a plugin
/plugins/{name}Remove a plugin
/secrets/createCreate a secret
/volumes/createCreate a volume
/volumes/{name}Inspect a volume
/volumes/{name}Remove a volume
/containers/jsonList containers
/containers/{id}Remove a container
/exec/{id}/startStart an exec instance
/networks/createCreate a network
/services/createCreate a service
/swarm/unlockkeyGet the unlock key
/tasks/{id}/logsGet task logs
/containers/pruneDelete stopped containers
/exec/{id}/resizeResize an exec instance
/containers/createCreate a container
/images/{name}/getExport an image
/images/{name}/tagTag an image
/nodes/{id}/updateUpdate a node
/images/{name}/jsonInspect an image
/images/{name}/pushPush an image
/plugins/privilegesGet plugin privileges
/plugins/{name}/setConfigure a plugin
/services/{id}/logsGet service logs
/configs/{id}/updateUpdate a Config
/containers/{id}/topList processes running inside a container
/plugins/{name}/jsonInspect a plugin
/plugins/{name}/pushPush a plugin
/secrets/{id}/updateUpdate a Secret
/containers/{id}/execCreate an exec instance
/containers/{id}/jsonInspect a container
/containers/{id}/killKill a container
/containers/{id}/logsGet container logs
/containers/{id}/stopStop a container
/containers/{id}/waitWait for a container
/services/{id}/updateUpdate a service
/containers/{id}/pausePause a container
/containers/{id}/startStart a container
/containers/{id}/statsGet container stats based on resource usage
/images/{name}/historyGet the history of an image
/networks/{id}/connectConnect a container to a network
/plugins/{name}/enableEnable a plugin
/containers/{id}/attachAttach to a container
/containers/{id}/exportExport a container
/containers/{id}/renameRename a container
/containers/{id}/resizeResize a container TTY
/containers/{id}/updateUpdate a container
/plugins/{name}/disableDisable a plugin
/plugins/{name}/upgradeUpgrade a plugin
/containers/{id}/archiveGet an archive of a filesystem resource in a container
/containers/{id}/archiveExtract an archive of files or folders to a directory in a container
/containers/{id}/changesGet changes on a container’s filesystem
/containers/{id}/restartRestart a container
/containers/{id}/unpauseUnpause a container
/distribution/{name}/jsonGet image information from the registry
/networks/{id}/disconnectDisconnect a container from a network
/containers/{id}/attach/wsAttach to a container via a websocket
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. # Errors 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: ``` { "message": "page not found" } ``` # Versioning The API is usually changed in each release of Docker, so API calls are versioned to ensure that clients don't break. For Docker Engine 17.09, the API version is 1.32. To lock to this version, you prefix the URL with `/v1.32`. For example, calling `/info` is the same as calling `/v1.32/info`. Engine releases in the near future should support this version of the API, so your client will continue
/v1.33104 endpoints available
/authCheck auth configuration
/infoGet system information
/_pingPing
/buildBuild an image
/nodesList nodes
/swarmInspect swarm
/tasksList tasks
/commitCreate a new image from a container
/eventsMonitor events
/configsList configs
/pluginsList plugins
/secretsList secrets
/sessionInitialize interactive session
/versionGet version
/volumesList volumes
/networksList networks
/servicesList services
/system/dfGet data usage information
/images/getExport several images
/nodes/{id}Inspect a node
/nodes/{id}Delete a node
/swarm/initInitialize a new swarm
/swarm/joinJoin an existing swarm
/tasks/{id}Inspect a task
/build/pruneDelete builder cache
/images/jsonList Images
/images/loadImport images
/swarm/leaveLeave a swarm
/configs/{id}Inspect a config
/configs/{id}Delete a config
/images/pruneDelete unused images
/plugins/pullInstall a plugin
/secrets/{id}Inspect a secret
/secrets/{id}Delete a secret
/swarm/unlockUnlock a locked manager
/swarm/updateUpdate a swarm
/images/createCreate an image
/images/searchSearch images
/images/{name}Remove an image
/networks/{id}Inspect a network
/networks/{id}Remove a network
/services/{id}Inspect a service
/services/{id}Delete a service
/volumes/pruneDelete unused volumes
/configs/createCreate a config
/exec/{id}/jsonInspect an exec instance
/networks/pruneDelete unused networks
/plugins/createCreate a plugin
/plugins/{name}Remove a plugin
/secrets/createCreate a secret
/volumes/createCreate a volume
/volumes/{name}Inspect a volume
/volumes/{name}Remove a volume
/containers/jsonList containers
/containers/{id}Remove a container
/exec/{id}/startStart an exec instance
/networks/createCreate a network
/services/createCreate a service
/swarm/unlockkeyGet the unlock key
/tasks/{id}/logsGet task logs
/containers/pruneDelete stopped containers
/exec/{id}/resizeResize an exec instance
/containers/createCreate a container
/images/{name}/getExport an image
/images/{name}/tagTag an image
/nodes/{id}/updateUpdate a node
/images/{name}/jsonInspect an image
/images/{name}/pushPush an image
/plugins/privilegesGet plugin privileges
/plugins/{name}/setConfigure a plugin
/services/{id}/logsGet service logs
/configs/{id}/updateUpdate a Config
/containers/{id}/topList processes running inside a container
/plugins/{name}/jsonInspect a plugin
/plugins/{name}/pushPush a plugin
/secrets/{id}/updateUpdate a Secret
/containers/{id}/execCreate an exec instance
/containers/{id}/jsonInspect a container
/containers/{id}/killKill a container
/containers/{id}/logsGet container logs
/containers/{id}/stopStop a container
/containers/{id}/waitWait for a container
/services/{id}/updateUpdate a service
/containers/{id}/pausePause a container
/containers/{id}/startStart a container
/containers/{id}/statsGet container stats based on resource usage
/images/{name}/historyGet the history of an image
/networks/{id}/connectConnect a container to a network
/plugins/{name}/enableEnable a plugin
/containers/{id}/attachAttach to a container
/containers/{id}/exportExport a container
/containers/{id}/renameRename a container
/containers/{id}/resizeResize a container TTY
/containers/{id}/updateUpdate a container
/plugins/{name}/disableDisable a plugin
/plugins/{name}/upgradeUpgrade a plugin
/containers/{id}/archiveGet an archive of a filesystem resource in a container
/containers/{id}/archiveExtract an archive of files or folders to a directory in a container
/containers/{id}/changesGet changes on a container’s filesystem
/containers/{id}/restartRestart a container
/containers/{id}/unpauseUnpause a container
/distribution/{name}/jsonGet image information from the registry
/networks/{id}/disconnectDisconnect a container from a network
/containers/{id}/attach/wsAttach to a container via a websocket