List commands fires for converge action
Retrieves the underlying commands that were fired to carry out a specific Converge action.
A single Converge action can result in multiple individual commands being dispatched to a device (for example, installing apps and applying settings); this endpoint lists each of those commands along with its own state.
About Converge Commands
Converge doesn't apply a blueprint to a device directly; it decomposes the blueprint's configuration into individual commands and dispatches them. This endpoint exposes that breakdown, which is the most direct way to identify exactly which underlying action caused a Converge action to fail.
Key Fields / Query Parameters
command_state — each result's current state, for example Command Failure or Command Success
Common Use Cases
Identifying which specific command caused a Converge action to fail, for example a failed app install versus a failed settings change
Auditing the full set of commands a Converge action generated
Best Practices
Check each command's command_state and reason individually rather than relying on the Converge action's overall status alone, since one failed command among several is enough to fail the whole Converge action
Cross-reference command_request_id with GET /commands/v0/status/ if you need device-level command status detail beyond what's returned here
Workflow
Identify a Converge action with a FAILURE status from the Converge list or detail endpoint
Call this endpoint with that converge id
Review each command's command_state to find the one that failed
Request
- Base URLhttps://develop-api.esper.cloud/api
- URLhttps://develop-api.esper.cloud/api/v2/converge/{id}/commands
- AuthHTTP bearer
Path parameters
ID of the converge object
Query parameters
Response
List of commands fired for converge action for the tenant
Changes
No recorded changes to this operation across all 6 revisions of this API.