Subscribe to real-time deployment change events.

GET 
/api/v2/events/deploy

Opens an SSE stream that fires whenever a deployment state changes. The payload is the native Deploy record — requiring no follow-up HTTP fetch by the consumer. Consumers should filter events by catalog_id to handle multiple concurrent deployments.

Request

Responses

200

SSE stream — fires Deploy on every deploy state change

text/event-stream

Schema

Schema

action string

Manifest action this status belongs to (install for legacy and V1 deploys).

catalogId stringrequired
completedAt date-timenullable
currentTime date-timenullable
deviceId stringrequired
eta int64nullable
messageLog stringnullable

Progress/status log. For a Deploy V2 component this is a JSON string of the DeployV2StatusLog struct (parse it for per-task messages and any error); for legacy deploys it is plain text.

progress int32nullable
requestedStatus object
startedAt date-timenullable
status object
stoppedAt date-timenullable
type ItemTyperequired

Possible values: [software, map, cache, config]

Example (from schema)

{
  "action": "string",
  "catalogId": "string",
  "completedAt": "2026-11-08T13:48:42.677Z",
  "currentTime": "2026-11-08T13:48:42.677Z",
  "deviceId": "string",
  "eta": 0,
  "messageLog": "string",
  "progress": 0,
  "requestedStatus": "Start",
  "startedAt": "2026-11-08T13:48:42.677Z",
  "status": "Start",
  "stoppedAt": "2026-11-08T13:48:42.677Z",
  "type": "software"
}

Loading...