Create a process

Stages new code as a process. The optional block flag waits until execution is idle before the response is returned. The optional timeout is expressed in milliseconds and may be null to explicitly clear it.

POST /processes

Create a process

cURL

curl --request POST \
  --url http://localhost:7687/processes \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "block": true,
  "ref": "<string>",
  "timeout": 1
}
'

201

{
  "pid": 1
}

Body

application/json

Request body used to create a new process entry.

code · string · required

Executable source code or script body to stage and run in the process environment.

block · boolean

When true, waits for the process to become idle before responding.

ref · string

Optional reference label used for filtering and correlation.

Minimum string length: 1

timeout · integer | null

Optional timeout in milliseconds. Null explicitly clears the timeout.

Required range: x > 0

Response

201

application/json

Process created successfully.

Response returned when a process is created.

pid · integer · required

Numeric identifier assigned to the newly created process.

Required range: x > 0