Wait for a sandbox to be ready
curl --request GET \
--url https://api.brimble.io/core/v1/sandboxes/{id}/wait \
--header 'x-brimble-key: <api-key>'import requests
url = "https://api.brimble.io/core/v1/sandboxes/{id}/wait"
headers = {"x-brimble-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-brimble-key': '<api-key>'}};
fetch('https://api.brimble.io/core/v1/sandboxes/{id}/wait', 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.brimble.io/core/v1/sandboxes/{id}/wait",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.brimble.io/core/v1/sandboxes/{id}/wait"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-brimble-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.brimble.io/core/v1/sandboxes/{id}/wait")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/sandboxes/{id}/wait")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-brimble-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "Sandbox ready",
"data": {
"id": "<string>",
"name": "<string>",
"template": "<string>",
"size": "<string>",
"status": "starting",
"region": "<string>",
"specs": {
"cpu": 123,
"memory": 123,
"disk": 123
},
"team": "<string>",
"project_environment": "<string>",
"auto_destroy": true,
"destroy_timeout": "<string>",
"one_shot": true,
"block_outbound": true,
"egress": {
"mode": "open",
"allow": [
"<string>"
]
},
"persistent": true,
"persistent_disk_gb": 123,
"paused_at": "2023-11-07T05:31:56Z",
"from_snapshot": "<string>",
"snapshot_mode": "automatic",
"snapshot_frequency": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_activity_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"destroyed_at": "2023-11-07T05:31:56Z",
"destroy_reason": "user",
"network_updated": true
}
}{
"errors": [
{
"type": "field",
"value": "<unknown>",
"msg": "Invalid value",
"path": "name",
"location": "body"
}
]
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Sandboxes
Wait for a sandbox to be ready
API key scope: sandbox.read
Team role permission: sandbox.read
GET
/
v1
/
sandboxes
/
{id}
/
wait
Wait for a sandbox to be ready
curl --request GET \
--url https://api.brimble.io/core/v1/sandboxes/{id}/wait \
--header 'x-brimble-key: <api-key>'import requests
url = "https://api.brimble.io/core/v1/sandboxes/{id}/wait"
headers = {"x-brimble-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-brimble-key': '<api-key>'}};
fetch('https://api.brimble.io/core/v1/sandboxes/{id}/wait', 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.brimble.io/core/v1/sandboxes/{id}/wait",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.brimble.io/core/v1/sandboxes/{id}/wait"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-brimble-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.brimble.io/core/v1/sandboxes/{id}/wait")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/sandboxes/{id}/wait")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-brimble-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "Sandbox ready",
"data": {
"id": "<string>",
"name": "<string>",
"template": "<string>",
"size": "<string>",
"status": "starting",
"region": "<string>",
"specs": {
"cpu": 123,
"memory": 123,
"disk": 123
},
"team": "<string>",
"project_environment": "<string>",
"auto_destroy": true,
"destroy_timeout": "<string>",
"one_shot": true,
"block_outbound": true,
"egress": {
"mode": "open",
"allow": [
"<string>"
]
},
"persistent": true,
"persistent_disk_gb": 123,
"paused_at": "2023-11-07T05:31:56Z",
"from_snapshot": "<string>",
"snapshot_mode": "automatic",
"snapshot_frequency": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_activity_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"destroyed_at": "2023-11-07T05:31:56Z",
"destroy_reason": "user",
"network_updated": true
}
}{
"errors": [
{
"type": "field",
"value": "<unknown>",
"msg": "Invalid value",
"path": "name",
"location": "body"
}
]
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Authorizations
ApiKeyAuthBearerAuth
API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.
Path Parameters
Pattern:
^[a-fA-F0-9]{24}$Query Parameters
Timeout must be an integer between 1 and 60 seconds
Required range:
1 <= x <= 60Last modified on October 10, 2026
Was this page helpful?