Search or ask Docker

EventMessage

EventMessage schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

EventMessage represents the information an event contains.
Action

Type: string

The type of event
All schema constraints and annotations
{
  "description": "The type of event",
  "example": "create",
  "type": "string"
}
Actor

Schema: EventActor

Type

Type: string

The type of object emitting the event
All schema constraints and annotations
{
  "description": "The type of object emitting the event",
  "enum": [
    "builder",
    "config",
    "container",
    "daemon",
    "image",
    "network",
    "node",
    "plugin",
    "secret",
    "service",
    "volume"
  ],
  "example": "container",
  "type": "string"
}
scope

Type: string

Scope of the event. Engine events are local scope. Cluster (Swarm) events are swarm scope.
All schema constraints and annotations
{
  "description": "Scope of the event. Engine events are `local` scope. Cluster (Swarm)\nevents are `swarm` scope.\n",
  "enum": [
    "local",
    "swarm"
  ],
  "type": "string"
}
time

Type: integer

Timestamp of event
All schema constraints and annotations
{
  "description": "Timestamp of event",
  "example": 1629574695,
  "format": "int64",
  "type": "integer"
}
timeNano

Type: integer

Timestamp of event, with nanosecond accuracy
All schema constraints and annotations
{
  "description": "Timestamp of event, with nanosecond accuracy",
  "example": 1629574695515050000,
  "format": "int64",
  "type": "integer"
}
All schema constraints and annotations
{
  "description": "EventMessage represents the information an event contains.\n",
  "properties": {
    "Action": {
      "description": "The type of event",
      "example": "create",
      "type": "string"
    },
    "Actor": {
      "$ref": "#/components/schemas/EventActor"
    },
    "Type": {
      "description": "The type of object emitting the event",
      "enum": [
        "builder",
        "config",
        "container",
        "daemon",
        "image",
        "network",
        "node",
        "plugin",
        "secret",
        "service",
        "volume"
      ],
      "example": "container",
      "type": "string"
    },
    "scope": {
      "description": "Scope of the event. Engine events are `local` scope. Cluster (Swarm)\nevents are `swarm` scope.\n",
      "enum": [
        "local",
        "swarm"
      ],
      "type": "string"
    },
    "time": {
      "description": "Timestamp of event",
      "example": 1629574695,
      "format": "int64",
      "type": "integer"
    },
    "timeNano": {
      "description": "Timestamp of event, with nanosecond accuracy",
      "example": 1629574695515050000,
      "format": "int64",
      "type": "integer"
    }
  },
  "title": "SystemEventsResponse",
  "type": "object"
}