Send kill signal

Stops a queued or running process.

POST /processes/{pid}/signals/kill

Send kill signal

cURL

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

200

{
  "pid": 1,
  "state": "idle",
  "status": "canceled"
}

Path Parameters

pid · integer · required

The process ID returned by POST /processes.

Example:

1

Body

application/json

Empty body — reserved for future signal options.

Response

200

application/json

Kill signal accepted.

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.