Start Bash Command

Execute a bash command in the background

POST /api/bash/start_bash_command

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
}
'

import requests

url = "https://api.example.com/api/bash/start_bash_command"

payload = {
    "command": "<string>",
    "cwd": "<string>",
    "timeout": 300
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({command: '<string>', cwd: '<string>', timeout: 300})
};

fetch('https://api.example.com/api/bash/start_bash_command', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/bash/start_bash_command",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'command' => '<string>',
    'cwd' => '<string>',
    'timeout' => 300
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/bash/start_bash_command"

	payload := strings.NewReader("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeout\": 300\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/bash/start_bash_command")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeout\": 300\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/bash/start_bash_command")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeout\": 300\n}"

response = http.request(request)
puts response.read_body

200

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

kind · string · required

Allowed value: "BashCommand"

cwd · string | null

The current working directory

timeout · integer · default: 300

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

id · string

timestamp · string<date-time>