ESC
Example searches: “since”, “*”, “404”, “Container”, “Gateway”
Search…
Ctrl+K
⌘K
Docker hub
Docker Engine API
Docker Hub API
DVP Data API
Supported registry API for Docker Hub
Back to hub page
API Explorer
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
main
main
default
1.44
Topics
Introduction
Getting started
Endpoints
Containers
List containers
GET
Create a container
POST
Inspect a container
GET
List processes running inside a container
GET
Get container logs
GET
Get changes on a container’s filesystem
GET
Export a container
GET
Get container stats based on resource usage
GET
Resize a container TTY
POST
Start a container
POST
Stop a container
POST
Restart a container
POST
Kill a container
POST
Update a container
POST
Rename a container
POST
Pause a container
POST
Unpause a container
POST
Attach to a container
POST
Attach to a container via a websocket
GET
Wait for a container
POST
Remove a container
DELETE
Get an archive of a filesystem resource in a container
GET
Extract an archive of files or folders to a directory in a container
PUT
Get information about files in a container
HEAD
Delete stopped containers
POST
Images
List Images
GET
Build an image
POST
Delete builder cache
POST
Create an image
POST
Inspect an image
GET
Get the history of an image
GET
Push an image
POST
Tag an image
POST
Remove an image
DELETE
Search images
GET
Delete unused images
POST
Create a new image from a container
POST
Export an image
GET
Export several images
GET
Import images
POST
Networks
List networks
GET
Inspect a network
GET
Remove a network
DELETE
Create a network
POST
Connect a container to a network
POST
Disconnect a container from a network
POST
Delete unused networks
POST
Volumes
List volumes
GET
Create a volume
POST
Inspect a volume
GET
"Update a volume. Valid only for Swarm cluster volumes"
PUT
Remove a volume
DELETE
Delete unused volumes
POST
Exec
Create an exec instance
POST
Start an exec instance
POST
Resize an exec instance
POST
Inspect an exec instance
GET
Swarm
Inspect swarm
GET
Initialize a new swarm
POST
Join an existing swarm
POST
Leave a swarm
POST
Update a swarm
POST
Get the unlock key
GET
Unlock a locked manager
POST
Nodes
List nodes
GET
Inspect a node
GET
Delete a node
DELETE
Update a node
POST
Services
List services
GET
Create a service
POST
Inspect a service
GET
Delete a service
DELETE
Update a service
POST
Get service logs
GET
Tasks
List tasks
GET
Inspect a task
GET
Get task logs
GET
Secrets
List secrets
GET
Create a secret
POST
Inspect a secret
GET
Delete a secret
DELETE
Update a Secret
POST
Configs
List configs
GET
Create a config
POST
Inspect a config
GET
Delete a config
DELETE
Update a Config
POST
Plugins
List plugins
GET
Get plugin privileges
GET
Install a plugin
POST
Inspect a plugin
GET
Remove a plugin
DELETE
Enable a plugin
POST
Disable a plugin
POST
Upgrade a plugin
POST
Create a plugin
POST
Push a plugin
POST
Configure a plugin
POST
System
Check auth configuration
POST
Get system information
GET
Get version
GET
Ping
GET
Ping
HEAD
Monitor events
GET
Get data usage information
GET
Distribution
Get image information from the registry
GET
Session
Initialize interactive session
POST
Search…
Ctrl+K
⌘K
Docker hub
Docker Engine API
Docker Hub API
DVP Data API
Supported registry API for Docker Hub
Back to hub page
API Explorer
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
Dismiss highlight
Show more
Distribution
