v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
device_Operations

Get specific Operation details (Operation Status)

Retrieves the full status and aggregate device counts for a single Dispatch operation.

Use this endpoint to check whether a Converge, install, or uninstall operation has resolved, how many devices it reached, and how many succeeded or failed. The operation_stats object gives the aggregate breakdown, while operation_activity gives a timestamped history of the operation's state transitions.

About Operation Status

An Operation moves through Created, Query Initiated, Query Resolved, Dispatching, Dispatched, Processing, and finally Success or Failure. The operation is only marked Success once every applicable device has executed the command successfully; a single device failure marks the whole operation Failure. Operations can remain indefinitely in Dispatched or Processing if devices are not picking up the command, which is usually a sign of network connectivity issues rather than a problem with the operation itself.

Common Use Cases

Polling an operation after creation to confirm it reached Success

Checking operation_stats to see how many of a large batch of devices failed a Converge action

Reviewing operation_activity to see how long an operation spent in each lifecycle state

Best Practices

Treat a Failure state as meaning at least one device failed, not that the entire batch failed; check operation_stats.failed_device_count for the real scope

If an operation is stuck in Dispatched or Processing, check the affected devices' connectivity rather than re-issuing the operation immediately

Use the state query parameter on GET /v0/operations/ to find other operations in the same state if you suspect a systemic issue

Workflow

Create the operation with POST /v0/operations/ and capture the returned id

Poll this endpoint until state reaches a terminal value

If state is Failure, call GET /v0/operations/{operationsId}/devices/ to identify which devices failed

Re-drive the operation for the failed devices once their connectivity is confirmed

get/v0/operations/{operationId}/

Path parameters

operationIdstring uuid required

ID of the Operation

Response

Operation information for the Tenant