Send unload signal

Removes an idle process from active memory, keeping its database record and outputs intact. The process id remains valid and can be revived later via the run signal. Returns a conflict when the process is not idle or is not in active memory.

POST /processes/{id}/signals/unload

Send unload signal

cURL

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

200

{
  "id": 1,
  "pid": 1,
  "state": "queued",
  "exitState": "failed",
  "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 unloaded from active memory.

Process snapshot returned by the process management endpoints.

id · integer · required

Stable process identifier assigned at creation. Persists across restarts.

Required range: x > 0

pid · integer | null · required

Ephemeral in-memory process identifier, or null when the process is not in active memory.

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