Cancel Metronome run
POST
/v1/metronomes/{metronomeId}/runs/{runId}/cancelMark a queued or running workflow run as cancelled. The executor observes cancellation between nodes and persists partial trace steps.
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 | — |
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.
200Metronome run cancelled or already terminalapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| data | object | No | — |
| data.id | string | No | Unique identifier. |
| data.metronomeId | string | No | — |
| data.userId | string | No | User ID. |
| data.triggerType | string | No | — |
| data.versionId | string | No | — |
| data.triggerEventId | string | No | — |
| data.idempotencyKey | string | No | — |
| data.status | queued | running | waiting_approval | paused | completed | failed | cancelled | No | Current lifecycle status. |
| data.input | object | No | — |
| data.output | object | No | — |
| data.error | string | No | — |
| data.startedAt | string | No | ISO 8601 timestamp. |
| data.queuedAt | string | No | — |
| data.nextAttemptAt | string | No | — |
| data.lockedAt | string | No | — |
| data.lockedBy | string | No | — |
| data.attemptCount | integer | No | — |
| data.maxAttempts | integer | No | — |
| data.timeoutMs | integer | No | — |
| data.attachedProjectId | string | No | — |
| data.attachedTicketId | string | No | — |
| data.completedAt | string | No | ISO 8601 timestamp. |
| data.createdAt | string | No | ISO 8601 timestamp. |
| data.updatedAt | string | No | ISO 8601 timestamp. |
404Metronome or run not found
None.