v1

latestSwagger 2.02026-08-06114111152.5 KB
App-automate Maestro

Cancel a Maestro run

Immediately cancels a queued or running Maestro run. The run is marked CANCELLED so its workers stop requesting devices and stop retrying, every flow that has not finished yet is closed out as cancelled, any device session the run already acquired is released, and any request still queued on the grid is dropped. Flows that already completed keep their results and reports. Cancelling is idempotent only in the sense that it is safe to call once: a run that has already reached a terminal state (DONE, FAILED or CANCELLED) returns 409.

post/v1/app-automate/maestro/{project_id}/{run_id}/cancel

Path parameters

project_idinteger required

Numeric Maestro project ID the run belongs to.

run_idinteger required

Numeric Maestro run ID to cancel.

Response

The run was cancelled.

successboolean required

Whether the cancel was applied.

cancelled_flow_countinteger required

How many flows were still queued or running and got closed out. 0 means the run held no unfinished flows (its device session, if any, is still released).