Get a process

Returns the current process snapshot for the requested process identifier.

GET /processes/{pid}

Get a process

cURL

curl --request GET \
  --url http://localhost:7687/processes/{pid}

200

{
  "pid": 1,
  "ref": "<string>"
}

Path Parameters

pid · integer · required

Numeric process identifier.

Required range: x > 0

Response

200

application/json

Process snapshot.

Process status snapshot returned by process management endpoints.

pid · integer · required

Numeric process identifier assigned by the API.

Required range: x > 0

state · enum<string> · required

Current lifecycle state of the process.

Available options: idle, queued, running, terminating

status · enum<string> | null · required

Terminal outcome of the process when it reaches the idle state.

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

ref · string

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

Minimum string length: 1