Send run signal

Re-queues an idle process for execution. Works on canceled processes as well as successfully completed ones. If the process is complete, force: true must be set to explicitly overwrite run and overwrite outputs.

POST /processes/{pid}/signals/run

cURL

normal

curl --request POST \
  --url http://localhost:7687/processes/{pid}/signals/run \
  --header 'Content-Type: application/json' \
  --data '{
  "force": false
}'

200

{
  "pid": 1,
  "state": "queued",
  "status": null
}

Path Parameters

pid · integer · required

The process ID returned by POST /processes.

Example:

1

Body

application/json

force · boolean · default: false

When true, overwrites any existing outputs from a prior execution. Required if the process completed successfully and already has output.

Response

200

application/json

Run signal accepted; process re-queued.

pid · integer · required

Unique identifier for the process.

Example:

1

state · enum<string> · required

Where the process is in its life-cycle.

Available options: queued, running, idle

status · enum<string> | null · required

The outcome of execution.

Available options: success, failed, canceled, null

ref · string | null

Client-provided reference identifying the source of the process.