Cancel Run
currents.cancel_run
ActionBusiness appsconnection required
Calls the Currents API with the connection's credentials.
Cancel a run that is still executing so its machines stop early.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Currents
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- project_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
run_id Identifier of the run to act on, as returned by currents.list_project_runs. | string | Yes | — | — | cGxheXdyaWdodC1ydW4tMQ |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"run_id": "cGxheXdyaWdodC1ydW4tMQ"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
runId The run that was cancelled. | string | — |
cancelled True once Currents accepted the cancellation. | boolean | — |
cancelledAt ISO-8601 timestamp of the cancellation. | string | — |
{
"cancelled": false,
"cancelledAt": "",
"runId": ""
}Related Currents nodes
See Cancel Run run in a workflow.
In a technical demo we add the Currents connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.