Create a process

Stages new code as a process and optionally runs it immediately (see autorun). The optional options.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:9371/processes \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "ref": "<string>",
  "options": {
    "timeout": 1
  },
  "autorun": true
}
'

201

{
  "id": 1
}

Body

application/json

Request body used to create a new process.

code · string · required

Executable source code to stage and run in the active environment (max 100 KB).

Maximum string length: 102400

ref · string

Optional reference label used for filtering and correlation.

Minimum string length: 1

options · object

Optional execution options for the process.

Show child attributes

autorun · boolean · default: true

Whether to start execution immediately. When false, the process is created in idle state and must be started via the run signal.

Response

201

application/json

Process created successfully.

Response returned after a process is created.

id · integer · required

Stable process identifier assigned to the newly created process.

Required range: x > 0