Cancel a run

POST

/api/v2/orchestrations/runs/{run_id}/cancel

Stop a run. On SynapseOrch Cloud stopped is false for a run that had already finished; it keeps the status it finished with.

A self-hosted install answers without stopped.

Authorization

apiKey

headerAuthorizationBearer <token>

An API key, sk-syn- and 32 characters. On SynapseOrch Cloud an owner or admin makes it under Settings → Developer; on a self-hosted install, under Settings → API Keys.

Path Parameters

run_id*string

The run.

Response Body

The cancel was requested.

application/json

response

status?string

run_id?string

stopped?boolean

curl -X POST "https://api.synapseorch.com/api/v2/orchestrations/runs/run_01a10a1553d57036bae3d17421a4ba16/cancel" \  -H "Authorization: Bearer sk-syn-..."

{  "status": "cancellation_requested",  "run_id": "run_01a10a1553d57036bae3d17421a4ba16",  "stopped": true}