Execute in runtime sandbox

Run a shell command in the workspace runtime sandbox. Tracked working-tree changes the command produced (additions, edits, deletions, renames) are auto-committed and pushed to the workspace’s default branch as a single commit. Pass commitMessage to customize the commit subject; gitignored paths are skipped. The response’s commit field is present iff a commit landed.

POST /context/runtime/execute

Execute in runtime sandbox

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/context/runtime/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "<string>",
  "args": [
    "<string>"
  ],
  "commitMessage": "<string>"
}
'

import requests

url = "https://api.getcargo.io/v1/context/runtime/execute"

payload = {
    "command": "<string>",
    "args": ["<string>"],
    "commitMessage": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({command: '<string>', args: ['<string>'], commitMessage: '<string>'})
};

fetch('https://api.getcargo.io/v1/context/runtime/execute', 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.getcargo.io/v1/context/runtime/execute",
  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>',
    'args' => [
        '<string>'
    ],
    'commitMessage' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.getcargo.io/v1/context/runtime/execute"

	payload := strings.NewReader("{\n  \"command\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"commitMessage\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.getcargo.io/v1/context/runtime/execute")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"commitMessage\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/context/runtime/execute")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"command\": \"<string>\",\n  \"args\": [\n    \"<string>\"\n  ],\n  \"commitMessage\": \"<string>\"\n}"

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

200

{
  "exitCode": 123,
  "stdout": "<string>",
  "stderr": "<string>",
  "commit": {
    "sha": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Run a shell command in the workspace runtime sandbox. Tracked working-tree changes are auto-committed and pushed to the workspace's default branch; gitignored paths are skipped.

command · string · required

Shell command to run inside the runtime sandbox.

Minimum string length: 1

args · string[]

Optional arguments passed to the command.

commitMessage · string

Optional override for the auto-commit message. When the command leaves uncommitted changes (additions, edits, deletions, renames) in the working tree, those changes are always pushed to the workspace repo's default branch as a single commit; this field only customizes the commit subject. Defaults to context(runtime): execute <command>.

Minimum string length: 1

Response

200

application/json

Successful response

exitCode · number · required

stdout · string · required

stderr · string · required

commit · Commit · object

Present iff the command left the working tree dirty AND the resulting auto-push landed on the default branch. Absent when the command produced no tracked changes or when the push didn't land — the server logs capture the reason in the latter case.

Show child attributes