Skip to content

Latest commit

 

History

History
184 lines (149 loc) · 9.06 KB

supported-api.md

File metadata and controls

184 lines (149 loc) · 9.06 KB
Raw

Supported Features

feature set based on the Docker Engine API v1.30

Since the Docker engine api tends to be backwards compatible, the Docker Client currently supports most other api versions, too.

This project tends to support most api endpoints, but it always depends on free time. If you're missing a feature, please file a new issue or a pull request and we'll add it as soon as possible. If you're looking for another Java based Docker library with similar feature set, check out the project at Java Docker API Client.

Management Commands

Checkpoints - Manage checkpoints (0/3)

  • docker checkpoints create: Create a checkpoint from a running container
  • docker checkpoints ls: List checkpoints for a container
  • docker checkpoints rm: Remove a checkpoint

Config - Manage Docker configs (5/5)

  • docker configs create: Create a configuration file
  • docker configs inspect: Display detailed information on one or more configuration files
  • docker configs ls: List configs
  • docker configs rm: Remove one or more configuration files
  • Update a config POST /configs/{id}/update

Container - Manage containers (31/32)

  • docker container attach <container>: Attach to a running container (supports interactive tty)
  • Attach to a running container (websocket)
  • Resize a container TTY
  • docker container commit <container>: Create a new image from a container's changes
  • docker container cp <container>:<path> <hostpath>: Get an archive of a filesystem resource in a container
  • docker container cp <hostpath> <container>:<path>: Extract an archive of files or folders to a directory in a container
  • Retrieve information about files and folders in a container
  • docker container create: Create a new container
  • docker container diff <container>: Inspect changes on a container's filesystem
  • docker container exec <container> <command>: Run a command in a running container
  • Exec Start (supports interactive tty)
  • Exec Create
  • Exec Resize
  • Exec Inspect
  • docker container export <container>: Export a container's filesystem as a tar archive
  • docker container inspect <container>: Display detailed information on one or more containers
  • docker container kill <container>: Kill one or more running containers
  • docker container logs <container>: Fetch the logs of a container
  • docker container ps: List containers (alias for ls, list)
  • docker container pause <container>: Pause all processes within one or more containers
  • docker container port: List port mappings or a specific mapping for the container
  • docker container prune: Remove all stopped containers
  • docker container rename <container>: Rename a container
  • docker container restart <container>: Restart one or more containers
  • docker container rm <container>: Remove one or more containers
  • docker container run: Run a command in a new container
  • docker container start <container>: Start one or more stopped containers
  • docker container stats <container>: Display a live stream of container(s) resource usage statistics
  • docker container stop <container>: Stop one or more running containers
  • docker container top <container>: Display the running processes of a container
  • docker container unpause <container>: Unpause all processes within one or more containers
  • docker container update <container> [<container>...]: Update configuration of one or more containers
  • docker container wait <container>: Block until one or more containers stop, then print their exit codes

Image - Manage images (14/14)

  • docker image build: Build an image from a Dockerfile
  • docker image history <image>: Show the history of an image
  • docker image import: Import the contents from a tarball to create a filesystem image (from stream)
  • docker image import: Import the contents from a tarball to create a filesystem image (from url)
  • docker image inspect <image>: Display detailed information on one or more images
  • docker image load: Load a tarball with a set of images and tags into docker
  • docker image ls: List Images
  • docker image prune: Remove unused images
  • docker image pull: Pull an image or a repository from a registry
  • docker image push <image>: Push an image or a repository to a registry
  • docker image rm <image>: Remove one or more images
  • docker image save <image>: Get a tarball containing all images in a repository
  • docker image save <image> [<image> ...]: Get a tarball containing all images.
  • docker image tag <image> <repository>: Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE

Network - Manage networks (7/7)

  • docker network connect: Connect a container to a network
  • docker network create: Create a network
  • docker network disconnect: Disconnect a container from a network
  • docker network inspect: Display detailed information on one or more networks
  • docker network ls: List networks
  • docker network prune: Remove all unused networks
  • docker network rm: Remove one or more networks

Node - Manage Swarm nodes (7/7)

  • docker node demote: Demote a node from manager in the swarm
  • docker node inspect: Inspect a node in the swarm
  • docker node ls: List nodes in the swarm
  • docker node promote: Promote a node to a manager in the swarm
  • docker node ps: List tasks running on a node
  • docker node rm: Remove a node from the swarm
  • docker node update: Update a node

Plugin - Manage plugins (0/11)

  • docker plugin create: Create a plugin from a rootfs and config POST /plugins/create
  • docker plugin disable: Disable a plugin POST /plugins/{name:.*}/disable
  • docker plugin enable: Enable a plugin POST /plugins/{name:.*}/enable
  • docker plugin inspect: Inspect a plugin GET /plugins/{name:.*}/json
  • docker plugin install: Install a plugin (equivalent to pull + enable)
  • docker plugin ls: List plugins GET /plugins
  • Get plugin privileges GET /plugins/privileges
  • docker plugin push: Push a plugin POST /plugins/{name:.*}/push
  • Pull a plugin POST /plugins/pull
  • docker plugin rm: Remove a plugin DELETE /plugins/{name:.*}
  • docker plugin set: Change settings for a plugin POST /plugins/{name:.*}/set
  • docker plugin upgrade: Upgrade an existing plugin POST /plugins/{name:.*}/upgrade

Secrets - Manage Docker secrets (5/5)

  • docker secret create: Create a secret
  • docker secret inspect: Inspect a secret
  • docker secret ls: List secrets
  • Update a Secret POST /secrets/{id}/update
  • docker secret rm: Delete a secret

Service - Manage services (7/9)

  • docker service create: Create a service
  • docker service inspect: Return information on the service <id>
  • docker service logs: Get service logs (GET /services/{id}/logs)
  • docker service ls: List services
  • docker service ps: List the tasks of a service
  • docker service rm: Remove a service
  • docker service scale: Scale one or multiple services
  • docker service update: Update a service
  • Get task logs (GET /tasks/{id}/logs)

Stack - Manage Docker stacks (5/5)

  • docker stack deploy: Deploy a new stack or update an existing stack
  • docker stack ls: List stacks
  • docker stack ps: List the tasks in the stack
  • docker stack rm: Remove the stack
  • docker stack services: List the services in the stack

Swarm - Manage Swarm (8/8)

  • docker swarm init: Initialize a Swarm
  • docker swarm join: Join a Swarm as a node and/or manager
  • docker swarm join-token: Manage join tokens
  • docker swarm leave: Leave a Swarm
  • docker swarm inspect: Inspect the Swarm
  • docker swarm unlock: Unlock swarm
  • docker swarm unlock-key: Manage the unlock key
  • docker swarm update: Update the Swarm

System - Manage Docker (3/4)

  • docker system info: Display system-wide information
  • docker system df: Show docker disk usage
  • docker system events: Monitor Docker's events
  • docker system prune: Remove unused data

Volume - Manage volumes (5/5)

  • docker volume create: Create a volume
  • docker volume inspect: Display detailed information on one or more volumes
  • docker volume ls: List volumes from all volume drivers
  • docker volume prune: Remove all unused volumes
  • docker volume rm: Remove one or more volumes

Other Commands

Misc (5/5)

  • Get image descriptor GET /distribution/(name)/json
  • docker search <term>: Search the Docker Hub for images
  • docker version: Show the docker version information
  • Check auth configuration
  • Ping the docker server

Tasks (2/2)

  • List all tasks
  • Get details on a task