Send kill signal

Stops a queued or running process by id, returning the updated process record.

POST /processes/{id}/signals/kill

Send kill signal

cURL

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

200

{
  "id": 1,
  "error": "<string>",
  "createdAt": "<string>",
  "completedAt": "<string>",
  "ref": "<string>"
}

Path Parameters

id · string · required

Numeric process identifier serialized as a path parameter.

Body

application/json

Any JSON object. The payload is ignored and only object-ness is validated.

{key} · unknown

Response

200

application/json

The process was stopped.

Process snapshot returned by the process management endpoints.

id · integer · required

Stable process identifier assigned at creation. Persists across restarts.

Required range: x > 0

state · enum<string> · required

Current lifecycle state of the process.

Available options: queued, running, idle, terminating

exitState · enum<string> | null · required

Terminal exit state of the process. Null until the process becomes idle.

Available options: failed, success, timeout, canceled, null

error · string | null · required

Error message captured during execution, or null if no error occurred.

createdAt · string · required

ISO-8601 timestamp of when the process was created.

completedAt · string | null · required

ISO-8601 timestamp of when the process completed, or null if still running.

ref · string

Optional caller-supplied reference string used to correlate related processes.

Minimum string length: 1