Run a shell command

POST

sandboxes

{id}

exec

Run a shell command

curl --request POST \
  --url https://sandbox.brimble.io/sandboxes/{id}/exec \
  --header 'Content-Type: application/json' \
  --header 'x-brimble-key: <api-key>' \
  --data '
{
  "cmd": "<string>",
  "timeout_seconds": 150,
  "cwd": "<string>",
  "env": {
    "NODE_ENV": "production",
    "DATABASE_URL": "postgres://..."
  },
  "stream": true
}
'

import requests

url = "https://sandbox.brimble.io/sandboxes/{id}/exec"

payload = {
    "cmd": "<string>",
    "timeout_seconds": 150,
    "cwd": "<string>",
    "env": {
        "NODE_ENV": "production",
        "DATABASE_URL": "postgres://..."
    },
    "stream": True
}
headers = {
    "x-brimble-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-brimble-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cmd: '<string>',
    timeout_seconds: 150,
    cwd: '<string>',
    env: {NODE_ENV: 'production', DATABASE_URL: 'postgres://...'},
    stream: true
  })
};

fetch('https://sandbox.brimble.io/sandboxes/{id}/exec', 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://sandbox.brimble.io/sandboxes/{id}/exec",
  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([
    'cmd' => '<string>',
    'timeout_seconds' => 150,
    'cwd' => '<string>',
    'env' => [
        'NODE_ENV' => 'production',
        'DATABASE_URL' => 'postgres://...'
    ],
    'stream' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-brimble-key: <api-key>"
  ],
]);

$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://sandbox.brimble.io/sandboxes/{id}/exec"

	payload := strings.NewReader("{\n  \"cmd\": \"<string>\",\n  \"timeout_seconds\": 150,\n  \"cwd\": \"<string>\",\n  \"env\": {\n    \"NODE_ENV\": \"production\",\n    \"DATABASE_URL\": \"postgres://...\"\n  },\n  \"stream\": true\n}")

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

	req.Header.Add("x-brimble-key", "<api-key>")
	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://sandbox.brimble.io/sandboxes/{id}/exec")
  .header("x-brimble-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cmd\": \"<string>\",\n  \"timeout_seconds\": 150,\n  \"cwd\": \"<string>\",\n  \"env\": {\n    \"NODE_ENV\": \"production\",\n    \"DATABASE_URL\": \"postgres://...\"\n  },\n  \"stream\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.brimble.io/sandboxes/{id}/exec")

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

request = Net::HTTP::Post.new(url)
request["x-brimble-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cmd\": \"<string>\",\n  \"timeout_seconds\": 150,\n  \"cwd\": \"<string>\",\n  \"env\": {\n    \"NODE_ENV\": \"production\",\n    \"DATABASE_URL\": \"postgres://...\"\n  },\n  \"stream\": true\n}"

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

{
  "message": "Exec completed",
  "data": {
    "stdout": "<string>",
    "stderr": "<string>",
    "exit_code": 123,
    "duration_ms": 123
  }
}

Authorizations

x-brimble-key

string

header

required

Your account-level Brimble API key. Find it in the dashboard under your profile drawer → API key (click the avatar in the sidebar). Available on paid plans only.

Path Parameters

string

required

24-char hex id of the sandbox.

Pattern: ^[a-f0-9]{24}$

Body

application/json

cmd

string

required

Shell command to run. Pipes / && / redirects all work.

timeout_seconds

integer

Defaults to 30. Process is killed at the limit.

Required range: 1 <= x <= 300

cwd

string

Absolute path inside the sandbox. Defaults to /.

env

object

Extra environment variables for this command only. Layered on top of the sandbox's existing environment; same-named keys here override the sandbox-level ones for this call. Values must be strings. Scoped to a single invocation, the next call starts with the sandbox defaults again.

Show child attributes

Example:

{
  "NODE_ENV": "production",
  "DATABASE_URL": "postgres://..."
}

stream

boolean

When true, the server keeps the connection open and streams stdout/stderr as Server-Sent Events (text/event-stream). Each event is a JSON object on a data: line; the last event is always { "type": "done", ... } or { "type": "error", ... }.

Response

Command completed.

When the request body has stream: true, the response is text/event-stream, one ExecStreamFrame per data: event, the last being a done event.

message

string

required

Example:

"Exec completed"

data

object

required

Show child attributes

Last modified on July 1, 2026

Run a code snippetWrites `code` to a temp file and runs it with the chosen interpreter. Cleaner than `/exec` for multi-line scripts because you don't have to deal with shell escaping. Response shape matches `/exec`. Supports the same `stream: true` opt-in as `/exec`; see that endpoint's description for the SSE event shape.

Run a shell command

curl --request POST \
  --url https://sandbox.brimble.io/sandboxes/{id}/exec \
  --header 'Content-Type: application/json' \
  --header 'x-brimble-key: <api-key>' \
  --data '
{
  "cmd": "<string>",
  "timeout_seconds": 150,
  "cwd": "<string>",
  "env": {
    "NODE_ENV": "production",
    "DATABASE_URL": "postgres://..."
  },
  "stream": true
}
'

import requests

url = "https://sandbox.brimble.io/sandboxes/{id}/exec"

payload = {
    "cmd": "<string>",
    "timeout_seconds": 150,
    "cwd": "<string>",
    "env": {
        "NODE_ENV": "production",
        "DATABASE_URL": "postgres://..."
    },
    "stream": True
}
headers = {
    "x-brimble-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-brimble-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cmd: '<string>',
    timeout_seconds: 150,
    cwd: '<string>',
    env: {NODE_ENV: 'production', DATABASE_URL: 'postgres://...'},
    stream: true
  })
};

fetch('https://sandbox.brimble.io/sandboxes/{id}/exec', 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://sandbox.brimble.io/sandboxes/{id}/exec",
  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([
    'cmd' => '<string>',
    'timeout_seconds' => 150,
    'cwd' => '<string>',
    'env' => [
        'NODE_ENV' => 'production',
        'DATABASE_URL' => 'postgres://...'
    ],
    'stream' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-brimble-key: <api-key>"
  ],
]);

$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://sandbox.brimble.io/sandboxes/{id}/exec"

	payload := strings.NewReader("{\n  \"cmd\": \"<string>\",\n  \"timeout_seconds\": 150,\n  \"cwd\": \"<string>\",\n  \"env\": {\n    \"NODE_ENV\": \"production\",\n    \"DATABASE_URL\": \"postgres://...\"\n  },\n  \"stream\": true\n}")

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

	req.Header.Add("x-brimble-key", "<api-key>")
	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://sandbox.brimble.io/sandboxes/{id}/exec")
  .header("x-brimble-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cmd\": \"<string>\",\n  \"timeout_seconds\": 150,\n  \"cwd\": \"<string>\",\n  \"env\": {\n    \"NODE_ENV\": \"production\",\n    \"DATABASE_URL\": \"postgres://...\"\n  },\n  \"stream\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.brimble.io/sandboxes/{id}/exec")

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

request = Net::HTTP::Post.new(url)
request["x-brimble-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cmd\": \"<string>\",\n  \"timeout_seconds\": 150,\n  \"cwd\": \"<string>\",\n  \"env\": {\n    \"NODE_ENV\": \"production\",\n    \"DATABASE_URL\": \"postgres://...\"\n  },\n  \"stream\": true\n}"

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

{
  "message": "Exec completed",
  "data": {
    "stdout": "<string>",
    "stderr": "<string>",
    "exit_code": 123,
    "duration_ms": 123
  }
}

Discovery

Sandboxes

Runtime

Observability

Snapshots

Volumes

Sandboxes

Snapshots

Observability

Runtime

Volumes

Run a shell command

Authorizations

Path Parameters

Body

Response