POST
/
v1
/
projects
/
{project}
/
boxes
/
{name}
/
exec
Execute a command in a box
curl --request POST \
  --url https://api.example.com/v1/projects/{project}/boxes/{name}/exec \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": [
    "<string>"
  ],
  "cwd": "<string>",
  "env": {},
  "no_hup": true,
  "shell": true,
  "tty": true,
  "user": "<string>"
}
'
{
  "detached": true,
  "exit_code": 123,
  "process": 123,
  "stderr": "<string>",
  "stdout": "<string>"
}

Path Parameters

project
string
required

Project name

name
string
required

Box name

Body

application/json
command
string[] | null
cwd
string | null
env
object
no_hup
boolean | null
shell
boolean | null
tty
boolean | null
user
string | null

Response

Command executed

detached
boolean | null
exit_code
integer<int32> | null
process
integer<int32> | null
stderr
string | null
stdout
string | null