Docker Engine API
  1. System
Docker Engine API
  • System
    • Ping
      GET
    • Check auth configuration
      POST
    • Monitor events
      GET
    • Get system information
      GET
    • Get data usage information
      GET
    • Get version
      GET
  • Image
    • Build an image
      POST
    • Delete builder cache
      POST
    • Create a new image from a container
      POST
    • Create an image
      POST
    • Export several images
      GET
    • List Images
      GET
    • Import images
      POST
    • Delete unused images
      POST
    • Search images
      GET
    • Remove an image
      DELETE
    • Export an image
      GET
    • Get the history of an image
      GET
    • Inspect an image
      GET
    • Push an image
      POST
    • Tag an image
      POST
  • Config
    • List configs
      GET
    • Create a config
      POST
    • Delete a config
      DELETE
    • Inspect a config
      GET
    • Update a Config
      POST
  • Container
    • Create a container
    • List containers
    • Delete stopped containers
    • Remove a container
    • Get an archive of a filesystem resource in a container
    • Get information about files in a container
    • Extract an archive of files or folders to a directory in a container
    • Attach to a container
    • Attach to a container via a websocket
    • Get changes on a container’s filesystem
    • Export a container
    • Inspect a container
    • Kill a container
    • Get container logs
    • Pause a container
    • Rename a container
    • Resize a container TTY
    • Restart a container
    • Start a container
    • Get container stats based on resource usage
    • Stop a container
    • List processes running inside a container
    • Unpause a container
    • Update a container
    • Wait for a container
  • Exec
    • Create an exec instance
    • Inspect an exec instance
    • Resize an exec instance
    • Start an exec instance
  • Distribution
    • Get image information from the registry
  • Network
    • List networks
    • Create a network
    • Delete unused networks
    • Remove a network
    • Inspect a network
    • Connect a container to a network
    • Disconnect a container from a network
  • Node
    • List nodes
    • Delete a node
    • Inspect a node
    • Update a node
  • Plugin
    • List plugins
    • Create a plugin
    • Get plugin privileges
    • Install a plugin
    • Remove a plugin
    • Disable a plugin
    • Enable a plugin
    • Inspect a plugin
    • Push a plugin
    • Configure a plugin
    • Upgrade a plugin
  • Secret
    • List secrets
    • Create a secret
    • Delete a secret
    • Inspect a secret
    • Update a Secret
  • Service
    • List services
    • Create a service
    • Delete a service
    • Inspect a service
    • Get service logs
    • Update a service
  • Session (experimental)
    • Initialize interactive session
  • Swarm
    • Inspect swarm
    • Initialize a new swarm
    • Join an existing swarm
    • Leave a swarm
    • Unlock a locked manager
    • Get the unlock key
    • Update a swarm
  • Task
    • List tasks
    • Inspect a task
  • Volume
    • List volumes
    • Create a volume
    • Delete unused volumes
    • Remove a volume
    • Inspect a volume
  • Get task logs
    GET
  1. System

Monitor events

/v1.33
/v1.33
/v1.33
/v1.33
GET
/events
System
Stream real-time events from the server.
Various objects within Docker report events when something happens to them.
Containers report these events: attach, commit, copy, create, destroy, detach, die, exec_create, exec_detach, exec_start, export, health_status, kill, oom, pause, rename, resize, restart, start, stop, top, unpause, and update
Images report these events: delete, import, load, pull, push, save, tag, and untag
Volumes report these events: create, mount, unmount, and destroy
Networks report these events: create, connect, disconnect, destroy, update, and remove
The Docker daemon reports these events: reload
Services report these events: create, update, and remove
Nodes report these events: create, update, and remove
Secrets report these events: create, update, and remove
Configs report these events: create, update, and remove
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1.33/events'
Response Response Example
200 - response
{
    "Action": "create",
    "Actor": {
        "Attributes": {
            "com.example.some-label": "some-label-value",
            "image": "alpine",
            "name": "my-container"
        },
        "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743"
    },
    "Type": "container",
    "time": 1461943101
}

Request

Query Params
since
string 
optional
Show events created since this timestamp then stream new events.
until
string 
optional
Show events created until this timestamp then stop streaming.
filters
string 
optional

A JSON encoded value of filters (a map[string][]string) to process on the event list. Available filters:

  • config=<string> config name or ID
  • container=<string> container name or ID
  • daemon=<string> daemon name or ID
  • event=<string> event type
  • image=<string> image name or ID
  • label=<string> image or container label
  • network=<string> network name or ID
  • node=<string> node ID
  • plugin= plugin name or ID
  • scope= local or swarm
  • secret=<string> secret name or ID
  • service=<string> service name or ID
  • type=<string> object to filter by, one of container, image, volume, network, daemon, plugin, node, service, secret or config
  • volume=<string> volume name

Responses

🟢200no error
application/json
Body
Action
string 
optional
The type of event
Actor
object 
optional
Attributes
object 
optional
Various key/value attributes of the object, depending on its type
ID
string 
optional
The ID of the object emitting the event
Type
string 
optional
The type of object emitting the event
time
integer 
optional
Timestamp of event
timeNano
integer <int64>
optional
Timestamp of event, with nanosecond accuracy
🟠400bad parameter
🔴500server error
Modified at 2022-09-10 17:56:06
Previous
Check auth configuration
Next
Get system information
Built with