Docker Engine 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.

Category: IT Services
Pack: DevSecOps

Configuration parameters

url — Server URL (e.g. https://www.example.com:1000) (required)
client_certificate — Docker Client Certificate (required)
client_key — (required)
ca_certificate — CA Certificate
insecure — Trust any certificate (not secure)
proxy — Use system proxy settings
identitytoken — Registry Identity Token
Registry Username —
registry_serveraddress — Registry Server Address (e.g. docker.io)

Commands (42)

docker-build-prune — Delete builder cache.
docker-config-create — Create a config.
docker-config-inspect — Inspect a config.
docker-config-list — List configs.
docker-container-changes — Get changes on a container's filesystem.
docker-container-create — Create a container.
docker-container-delete — Remove a container.
docker-container-inspect — Inspect a container.
docker-container-list — List containers.
docker-container-stats — Get container stats based on resource usage.
docker-container-top — List processes running inside a container.
docker-image-create — Create an image by either pulling it from a registry or importing it.
docker-image-delete — Remove an image, along with any untagged parent images that were referenced by that image. Images can't be removed if they have descendant images, are being used by a running container or are being used by a build.
docker-image-history — Get the history of an image.
docker-image-inspect — Inspect an image.
docker-image-list — List Images.
docker-image-prune — Delete unused images.
docker-image-push — Push an image to a registry. If you wish to push an image on to a private registry, that image must already have a tag which references the registry. For example, registry.example.com/myimage:latest. The push is cancelled if the HTTP connection is closed.
docker-image-search — Search images.
docker-image-tag — Tag an image so that it becomes part of a repository.
docker-network-create — Create a network.
docker-network-list — List networks.
docker-network-prune — Delete unused networks.
docker-node-inspect — Inspect a node.
docker-node-list — List nodes.
docker-secret-create — Create a secret.
docker-secret-inspect — Inspect a secret.
docker-secret-list — List secrets.
docker-swarm-init — Initialize a new swarm.
docker-swarm-inspect — Inspect swarm.
docker-swarm-join — Join an existing swarm.
docker-swarm-leave — Leave a swarm.
docker-swarm-unlock — Unlock a locked manager.
docker-swarm-unlockkey — Get the unlock key.
docker-system-data-usage — Get data usage information.
docker-system-info — Get system information.
docker-system-version — Get version.
docker-task-list — List tasks.
docker-volume-create — Create a volume.
docker-volume-inspect — Inspect a volume.
docker-volume-list — List volumes.
docker-volume-prune — Delete unused volumes.