Skip to main content

Dispatch a reactive command to one, many, or all connected devices

POST 
/api/v1/device/reactive/command

Pushes a command event (Discovery, Push, DeliveryStart, …) down each target device's managed-command SSE channel. deviceId accepts a single id or an array; pass the literal "all" to target every currently-connected device. Always returns a succeeded/failed summary — offline devices are reported, never an error.

Request​

Body

required

    deviceId

    object

    required

    Target device id(s): a single id, an array of ids, or the literal "all" to target every currently-connected device. Required and non-empty.

    oneOf

    string

    action stringrequired

    Possible values: [Discovery, Push, DeliveryStart, DeliveryStop, DeliveryCancel, DeliveryDelete, DeployStart, DeployPause, MetadataRequest]

    The action to push down the device channel.

    catalogId string

    Catalog id the action applies to (push/delivery/deploy).

    force boolean

    Force the action, bypassing device-side guards (e.g. resume a paused deploy).

    deployAction string

    Manifest action to run for DeployStart (e.g. install, uninstall, restart). Forwarded to the device as the event action. Absent means install.

    correlationId string

    Optional correlation id echoed back on device acks (D6).

Responses​

Schema

    succeeded string[]required

    Device ids that had an open channel and received the command.

    failed string[]required

    Device ids that were offline/unknown — not sent.

    succeededCount numberrequired

    Count of devices the command was sent to.

    failedCount numberrequired

    Count of devices that were offline/unknown.

Loading...