Skip to main content
POST
/
runs
/
{run_uid}
/
cancel
Cancel a run
curl --request POST \
  --url https://api.edges.run/v1/runs/{run_uid}/cancel \
  --header 'X-API-Key: <api-key>'
{
  "id": 123,
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "action_id": 123,
  "action_name": "<string>",
  "retry_count": 0,
  "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "execution_mode": "LIVE",
  "last_error": {
    "label": "<string>",
    "message": "<string>",
    "params": {}
  },
  "parameters": {},
  "callback": {
    "url": "<string>"
  },
  "status": "CREATED",
  "output_count": 0,
  "scheduled_run_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "started_at": "<string>",
  "finished_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}
uid is used for all the endpoints and Run manipulation.The id is an internal identifier returned to smooth and improve speed and accuracy if you have questions about your runs you will want to submit to the team.
This endpoint only applies to async and schedule execution modes. Live runs cannot be canceled as they are synchronous.
Canceling a run will stop all pending operations. Results already processed will still be available, but no further callbacks will be sent for this run.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
run_uid
string<uuid>
required

Run UUID

Response

Cancel the run

Cancel the run

​
id
integer

Run ID

​
uid
string<uuid>

Run UUID

​
action_id
integer

Action ID

​
action_name
string

Action name

​
retry_count
integer
default:0

Retry count

​
user_uid
string<uuid>

Member/User UUID

​
workspace_uid
string<uuid>

Workspace UUID

​
execution_mode
enum<string> | null

Execution mode

Available options:
LIVE,
ASYNC
​
last_error
object

Last error message

​
parameters
object
​
callback
object

Callback (only for async runs)

​
status
enum<string> | null

Run status

Available options:
CREATED,
INVALID,
QUEUED,
SCHEDULED,
BLOCKED,
STOPPED,
RUNNING,
FAILED,
PARTIAL_SUCCEEDED,
SUCCEEDED
​
output_count
integer | null
default:0

Number of outputs generated by the run

​
scheduled_run_uid
string<uuid> | null

If the run is scheduled, this field indicates the scheduled run UUID.

​
started_at
string | null

Started at

​
finished_at
string | null

Finished at

​
created_at
string

Created at

​
updated_at
string | null

Updated at