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

Query parameters

locationobject | any

Request body

requiredapplication/json

commandstringrequired

cwdstring

timeoutobjectrequired

Show properties

object

metadataobject

Responses

200Success

locationLocation.Inforequired

Show properties

directorystringrequired

workspaceIDobject

Show properties

object

projectobjectrequired

Show properties

idstringrequired

directorystringrequired

dataShell.Info1required

Show properties

idobjectrequired

Show properties

object

statusstringrequired

Allowed:runningexitedtimeoutkilled

commandstringrequired

cwdstringrequired

shellstringrequired

filestringrequired

pidobject

Show properties

object

exitnumber

metadataobjectrequired

timeobjectrequired

Show properties

startednumberrequired

completednumber

400InvalidRequestError

_tagstringrequired

Allowed:InvalidRequestError

messagestringrequired

kindstring | any

Show properties

Any of:

string

string

any

any

fieldstring | any

Show properties

Any of:

string

string

any

any

401UnauthorizedError

_tagstringrequired

Allowed:UnauthorizedError

messagestringrequired

Request

curl -X POST "/api/shell" \
  -H "Content-Type: application/json" \
  -d '{
  "command": "string",
  "cwd": "string",
  "timeout": {},
  "metadata": {}
}'

const response = await fetch("/api/shell", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "command": "string",
  "cwd": "string",
  "timeout": {},
  "metadata": {}
})
});

import requests

response = requests.post(
    "/api/shell",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "command": "string",
  "cwd": "string",
  "timeout": {},
  "metadata": {}
},
)

Response

{
  "location": {
    "directory": "string",
    "workspaceID": {},
    "project": {
      "id": "string",
      "directory": "string"
    }
  },
  "data": {
    "id": {},
    "status": "running",
    "command": "string",
    "cwd": "string",
    "shell": "string",
    "file": "string",
    "pid": {},
    "exit": 0,
    "metadata": {},
    "time": {
      "started": 0,
      "completed": 0
    }
  }
}