Sign in

v1

latestSwagger 2.02026-07-17107114423.2 KB
System

Monitor events

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, exec_die, export, health_status, kill, oom, pause, rename, resize, restart, start, stop, top, unpause, update, and prune

Images report these events: create, delete, import, load, pull, push, save, tag, untag, and prune`

Volumes report these events: create, mount, unmount, destroy, and prune

Networks report these events: create, connect, disconnect, destroy, update, remove, and prune

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

The Builder reports prune events

get/events

Query parameters

sincestring

Show events created since this timestamp then stream new events.

untilstring

Show events created until this timestamp then stop streaming.

filtersstring

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=<string> plugin name or ID
  • scope=<string> 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

Response

no error

Type'builder' | 'config' | 'container' | 'daemon' | 'image' | 'network' | 'node' | 'plugin' | 'secret' | 'service' | 'volume'

The type of object emitting the event

Actionstring

The type of event

scope'local' | 'swarm'

Scope of the event. Engine events are local scope. Cluster (Swarm) events are swarm scope.

timeinteger

Timestamp of event

timeNanointeger

Timestamp of event, with nanosecond accuracy

Example response

{
  "Type": "container",
  "Action": "create",
  "Actor": {
    "ID": "ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743",
    "Attributes": {
      "com.example.some-label": "some-label-value",
      "image": "alpine:latest",
      "name": "my-container"
    }
  },
  "time": 1629574695,
  "timeNano": 1629574695515050000
}