Run shell command

Spawn one non-interactive shell command for a location. Combined stdout/stderr is captured to a file pageable via output.

POST /api/shell

Run shell command

cURL

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

import requests

url = "https://api.example.com/api/shell"

payload = {
    "command": "<string>",
    "timeout": 1,
    "cwd": "<string>",
    "metadata": {}
}
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>', timeout: 1, cwd: '<string>', metadata: {}})
};

fetch('https://api.example.com/api/shell', 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/shell",
  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>',
    'timeout' => 1,
    'cwd' => '<string>',
    'metadata' => [
        
    ]
  ]),
  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/shell"

	payload := strings.NewReader("{\n  \"command\": \"<string>\",\n  \"timeout\": 1,\n  \"cwd\": \"<string>\",\n  \"metadata\": {}\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/shell")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"<string>\",\n  \"timeout\": 1,\n  \"cwd\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"timeout\": 1,\n  \"cwd\": \"<string>\",\n  \"metadata\": {}\n}"

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

200

{
  "location": {
    "directory": "<string>",
    "project": {
      "id": "<string>",
      "directory": "<string>"
    },
    "workspaceID": "<string>"
  },
  "data": {
    "id": "<string>",
    "command": "<string>",
    "cwd": "<string>",
    "shell": "<string>",
    "file": "<string>",
    "metadata": {},
    "time": {
      "started": 123,
      "completed": 123
    },
    "pid": 1,
    "exit": 123
  }
}

{
  "_tag": "InvalidRequestError",
  "message": "<string>",
  "kind": "<string>",
  "field": "<string>"
}

{
  "_tag": "UnauthorizedError",
  "message": "<string>"
}

Query Parameters

location · object | null

Show child attributes

Body

application/json

command · string · required

timeout · integer · required

Required range: x >= 0

cwd · string

metadata · object

Response

200

application/json

Success

location · object · required

Show child attributes

data · object · required

Show child attributes