Skip to main content
POST
/
process
Execute a command
curl --request POST \
  --url https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "ls -la",
  "env": {
    "{\"PORT\"": " \"3000\"}"
  },
  "maxRestarts": 3,
  "name": "my-process",
  "restartOnFailure": true,
  "timeout": 30,
  "waitForCompletion": false,
  "waitForPorts": [
    3000,
    8080
  ],
  "workingDir": "/home/user"
}
'
{
  "command": "ls -la",
  "completedAt": "Wed, 01 Jan 2023 12:01:00 GMT",
  "exitCode": 0,
  "logs": "logs output",
  "name": "my-process",
  "pid": "1234",
  "startedAt": "Wed, 01 Jan 2023 12:00:00 GMT",
  "status": "running",
  "stderr": "stderr output",
  "stdout": "stdout output",
  "workingDir": "/home/user",
  "maxRestarts": 3,
  "restartCount": 2,
  "restartOnFailure": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Process execution request

​
command
string
required
Example:

"ls -la"

​
env
object
Example:
{ "{\"PORT\"": " \"3000\"}" }
​
maxRestarts
integer
Example:

3

​
name
string
Example:

"my-process"

​
restartOnFailure
boolean
Example:

true

​
timeout
integer
Example:

30

​
waitForCompletion
boolean
Example:

false

​
waitForPorts
integer[]
Example:
[3000, 8080]
​
workingDir
string
Example:

"/home/user"

Response

Process information

​
command
string
required
Example:

"ls -la"

​
completedAt
string
required
Example:

"Wed, 01 Jan 2023 12:01:00 GMT"

​
exitCode
integer
required
Example:

0

​
logs
string
required
Example:

"logs output"

​
name
string
required
Example:

"my-process"

​
pid
string
required
Example:

"1234"

​
startedAt
string
required
Example:

"Wed, 01 Jan 2023 12:00:00 GMT"

​
status
enum<string>
required
Available options:
failed,
killed,
stopped,
running,
completed
Example:

"running"

​
stderr
string
required
Example:

"stderr output"

​
stdout
string
required
Example:

"stdout output"

​
workingDir
string
required
Example:

"/home/user"

​
maxRestarts
integer
Example:

3

​
restartCount
integer
Example:

2

​
restartOnFailure
boolean
Example:

true