Request durable cancellation of a child workflow group
POST
/v1/metronomes/{metronomeId}/runs/{runId}/groups/{groupId}/cancelIdempotently stops further admission and asynchronously cancels admitted Batch/native runs. Completed groups keep their terminal status. Cancelling a launcher run does not cancel detached groups automatically.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| metronomeId | path | string | Yes | Metronome workflow ID |
| runId | path | string | Yes | — |
| groupId | path | string | Yes | — |
Query parameters
None.
Body schema
This endpoint does not require a request body.
None.
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Durable cancellation receipt or existing terminal statusapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| data | object | Yes | — |
| data.id | string | Yes | Unique identifier. |
| data.status | running | cancelling | cancelled | completed | partial | failed | Yes | Current lifecycle status. |
401Authentication required
None.
403Execute permission denied
None.
404Workflow
None.
503Durable group store unavailable
None.
Request durable cancellation of a child workflow group
Loading...
Response 200
Loading...