Delete a process

Deletes an idle process record from the database. Active processes must be stopped before they can be deleted.

DELETE /processes/{id}

Delete a process

cURL

curl --request DELETE \
  --url http://localhost:9371/processes/{id}

200

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

Path Parameters

id · string · required

Numeric process identifier serialized as a path parameter.

Response

200

application/json

The deleted process snapshot.

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