curl --request POST \
--url https://{sandbox_key}.{domain}/executions \
--header 'Content-Type: application/json' \
--header 'X-Access-Token: <api-key>' \
--data @- <<EOF
{
"action": "exec",
"parameters": {
"command": "printf '%s\\n' \"$APP_ENV\"",
"envs": {
"APP_ENV": "production"
},
"cwd": "/workspace"
}
}
EOFimport requests
url = "https://{sandbox_key}.{domain}/executions"
payload = {
"action": "exec",
"parameters": {
"command": "printf '%s\n' \"$APP_ENV\"",
"envs": { "APP_ENV": "production" },
"cwd": "/workspace"
}
}
headers = {
"X-Access-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Access-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
action: 'exec',
parameters: {
command: 'printf \'%s\n\' "$APP_ENV"',
envs: {APP_ENV: 'production'},
cwd: '/workspace'
}
})
};
fetch('https://{sandbox_key}.{domain}/executions', 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_key}.{domain}/executions",
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([
'action' => 'exec',
'parameters' => [
'command' => 'printf \'%s\\n\' "$APP_ENV"',
'envs' => [
'APP_ENV' => 'production'
],
'cwd' => '/workspace'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Access-Token: <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_key}.{domain}/executions"
payload := strings.NewReader("{\n \"action\": \"exec\",\n \"parameters\": {\n \"command\": \"printf '%s\\\\n' \\\"$APP_ENV\\\"\",\n \"envs\": {\n \"APP_ENV\": \"production\"\n },\n \"cwd\": \"/workspace\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Access-Token", "<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_key}.{domain}/executions")
.header("X-Access-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"exec\",\n \"parameters\": {\n \"command\": \"printf '%s\\\\n' \\\"$APP_ENV\\\"\",\n \"envs\": {\n \"APP_ENV\": \"production\"\n },\n \"cwd\": \"/workspace\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{sandbox_key}.{domain}/executions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Access-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"exec\",\n \"parameters\": {\n \"command\": \"printf '%s\\\\n' \\\"$APP_ENV\\\"\",\n \"envs\": {\n \"APP_ENV\": \"production\"\n },\n \"cwd\": \"/workspace\"\n }\n}"
response = http.request(request)
puts response.read_body{
"execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sandbox_id": "<string>",
"status": "pending",
"exit_code": 123,
"stdout": "<string>",
"stderr": "<string>",
"stdout_truncated": true,
"stderr_truncated": true,
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"request_id": "<string>"
}{
"execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sandbox_id": "<string>",
"status": "pending",
"request_id": "<string>"
}{
"code": "Execution.InvalidRequest",
"message": "<string>",
"request_id": "<string>",
"details": {}
}{
"code": "Execution.InvalidRequest",
"message": "<string>",
"request_id": "<string>",
"details": {}
}{
"code": "Execution.InvalidRequest",
"message": "<string>",
"request_id": "<string>",
"details": {}
}{
"code": "Execution.InvalidRequest",
"message": "<string>",
"request_id": "<string>",
"details": {}
}Execute a command in a sandbox
Starts an asynchronous shell execution in the sandbox. The request body keeps the
action=exec and parameters shape used by the runtime contract. The effective URL is
the sandbox data-plane host; the sandbox ID is obtained from the leftmost Host label and
is not repeated in the path. The endpoint does not include the control-plane /api/v2 prefix.
When wait=true, the server waits for a terminal result for at most
wait_timeout_seconds seconds; a timeout returns 202 without canceling the execution.
curl --request POST \
--url https://{sandbox_key}.{domain}/executions \
--header 'Content-Type: application/json' \
--header 'X-Access-Token: <api-key>' \
--data @- <<EOF
{
"action": "exec",
"parameters": {
"command": "printf '%s\\n' \"$APP_ENV\"",
"envs": {
"APP_ENV": "production"
},
"cwd": "/workspace"
}
}
EOFimport requests
url = "https://{sandbox_key}.{domain}/executions"
payload = {
"action": "exec",
"parameters": {
"command": "printf '%s\n' \"$APP_ENV\"",
"envs": { "APP_ENV": "production" },
"cwd": "/workspace"
}
}
headers = {
"X-Access-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Access-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
action: 'exec',
parameters: {
command: 'printf \'%s\n\' "$APP_ENV"',
envs: {APP_ENV: 'production'},
cwd: '/workspace'
}
})
};
fetch('https://{sandbox_key}.{domain}/executions', 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_key}.{domain}/executions",
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([
'action' => 'exec',
'parameters' => [
'command' => 'printf \'%s\\n\' "$APP_ENV"',
'envs' => [
'APP_ENV' => 'production'
],
'cwd' => '/workspace'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Access-Token: <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_key}.{domain}/executions"
payload := strings.NewReader("{\n \"action\": \"exec\",\n \"parameters\": {\n \"command\": \"printf '%s\\\\n' \\\"$APP_ENV\\\"\",\n \"envs\": {\n \"APP_ENV\": \"production\"\n },\n \"cwd\": \"/workspace\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Access-Token", "<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_key}.{domain}/executions")
.header("X-Access-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"exec\",\n \"parameters\": {\n \"command\": \"printf '%s\\\\n' \\\"$APP_ENV\\\"\",\n \"envs\": {\n \"APP_ENV\": \"production\"\n },\n \"cwd\": \"/workspace\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{sandbox_key}.{domain}/executions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Access-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"exec\",\n \"parameters\": {\n \"command\": \"printf '%s\\\\n' \\\"$APP_ENV\\\"\",\n \"envs\": {\n \"APP_ENV\": \"production\"\n },\n \"cwd\": \"/workspace\"\n }\n}"
response = http.request(request)
puts response.read_body{
"execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sandbox_id": "<string>",
"status": "pending",
"exit_code": 123,
"stdout": "<string>",
"stderr": "<string>",
"stdout_truncated": true,
"stderr_truncated": true,
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"request_id": "<string>"
}{
"execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sandbox_id": "<string>",
"status": "pending",
"request_id": "<string>"
}{
"code": "Execution.InvalidRequest",
"message": "<string>",
"request_id": "<string>",
"details": {}
}{
"code": "Execution.InvalidRequest",
"message": "<string>",
"request_id": "<string>",
"details": {}
}{
"code": "Execution.InvalidRequest",
"message": "<string>",
"request_id": "<string>",
"details": {}
}{
"code": "Execution.InvalidRequest",
"message": "<string>",
"request_id": "<string>",
"details": {}
}Authorizations
Sandbox data-plane token — the sandbox_access_token returned by the create/connect endpoints. Used for /files, Sandbox-Exec, and other data-plane endpoints; the control plane (/api/v2) does not accept it, and conversely the control plane's Authorization: Bearer is invalid on the data plane.
The token is bound to its sandbox: using sandbox A's token against sandbox B's host fails. It stays valid until the sandbox's lifetime ends; there is no separate rotation endpoint (rotate_traffic_token rotates the port traffic token traffic_access_token and does not affect this one).
Headers
Optional request correlation identifier echoed in the response.
1 - 128Query Parameters
Wait for a terminal result before responding. Defaults to false.
Maximum time to wait when wait=true, in seconds. Values from 1 through 25
are accepted. A wait timeout never cancels the execution.
1 <= x <= 25Body
Response
Execution completed within the requested wait window.
Echo of the data-plane addressing key (i.e. sandbox_key; the data plane identifies the instance by the key in the host).
Public lifecycle status of a sandbox execution.
pending, running, canceling, succeeded, failed, canceled Process exit code; null while non-terminal or when canceled.
Captured standard output, or null while not yet available.
Captured standard error, or null while not yet available.
Echo of X-Request-ID when supplied.