Skip to main content

Device Status SSE Stream

GET 
/api/v1/device/status/stream

Server-Sent Events endpoint that pushes real-time device status updates (discovery, delivery, deploy). Optionally filter by projectId and/or deviceIds query parameters.

Each SSE message has the format: { data, id, type } where data is a JSON-serialized DeviceStatusEventDto.

Note: Not all properties are present on every event — availability depends on the statusType:

  • DISCOVERY: deviceId, status, timestamp, and optionally message, error, metadata.
  • DELIVERY: deviceId, releaseId, projectId, status, timestamp, and optionally progress, message, error.
  • DEPLOY: deviceId, releaseId, projectId, status, timestamp, and optionally progress, message, error.

Request​

Query Parameters

    projectId string

    Filter events by project ID

    deviceIds undefined[]

    Filter events by specific device IDs (comma-separated or repeated query params)

Responses​

SSE stream emitting device status update messages

Schema

    data

    object

    type stringrequired

    Default value: device_status_update

    deviceId stringrequired

    The device identifier

    projectId string

    Project ID the release belongs to. Present for DELIVERY and DEPLOY events.

    releaseId string

    Release/catalog ID being delivered or deployed. Present for DELIVERY and DEPLOY events.

    statusType stringrequired

    Possible values: [discovery, delivery, deploy, status]

    Which pipeline stage: discovery, delivery, or deploy

    status string

    Possible values: [new, discovered, Start, Done, Error, Download, Installing, Continue, Pause, Cancelled, Uninstall, Deleted]

    Current lifecycle status value (e.g. Start, Done, Error, Download, Installing). Present for DISCOVERY/DELIVERY/DEPLOY events.

    deviceStatus string[]

    Possible values: [updating, error, restricted]

    Resolved operational conditions (updating/error/restricted). Present for STATUS-type events.

    timestamp stringrequired

    ISO 8601 timestamp of when the event occurred

    message string

    Human-readable description of the event

    error string

    Error message when status is Error

    progress number

    Possible values: <= 100

    Progress percentage (0-100) for DELIVERY/DEPLOY events

    metadata

    object

    Device details. Typically present only for DISCOVERY events.

    id stringrequired
    lastUpdatedDate date-time
    lastConnectionDate date-time
    name string
    OS string
    availableStorage string
    power number
    bandwidth number
    operativeState boolean
    state string

    Possible values: [online, active, offline, disconnected]

    Connectivity state, computed at read-time: online > active > offline > disconnected.

    status string[]

    Possible values: [updating, error, restricted]

    Operational conditions; a device may have several at once (updating/error/restricted).

    online boolean

    True when the device currently holds an open reactive (managed-command) SSE channel.

    metaData object
    groupName string
    groupId number
    uid string
    formations string[]
    platformName string
    platformTypeName string

    The device's platform type name (server-derived from the platform_type catalog).

    deviceTypeName string
    devices string[]
    platformId string

    Platform instance id reported by the agent.

    id stringrequired

    Unique event ID (timestamp-based)

    type stringrequired

    SSE event type

Loading...