Start Bash Command

Execute a bash command in the background

POST /api/bash/start_bash_command

Try it

Start Bash Command

cURL

curl --request POST \
  --url https://api.example.com/api/bash/start_bash_command \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "<string>",
  "cwd": "<string>",
  "timeout": 300
}
'

200

{
  "command": "<string>",
  "cwd": "<string>",
  "timeout": 300,
  "kind": "BashCommand",
  "id": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Body

application/json

command · string · required

The bash command to execute

cwd · string | null

The current working directory

timeout · integer · default: 300

The max number of seconds a command may be permitted to run.

Response

200

application/json

Successful Response

command · string · required

The bash command to execute

cwd · string | null

The current working directory

timeout · integer · default: 300

The max number of seconds a command may be permitted to run.

kind · string · default: BashCommand

Allowed value: "BashCommand"

id · string

timestamp · string<date-time>