Get a Sandbox
curl --request GET \
--url https://api.example.com/v2/sandboxes/boxes/{name}import requests
url = "https://api.example.com/v2/sandboxes/boxes/{name}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v2/sandboxes/boxes/{name}', 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.example.com/v2/sandboxes/boxes/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v2/sandboxes/boxes/{name}"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v2/sandboxes/boxes/{name}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/sandboxes/boxes/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"template_name": "<string>",
"status": "provisioning",
"status_message": "<string>",
"dataplane_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}{
"detail": {
"error": "NotFound",
"message": "Resource not found."
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Get a Sandbox
Get a specific Sandbox by name in tenant’s namespace.
This endpoint queries the database for fast performance.
GET
/
v2
/
sandboxes
/
boxes
/
{name}
Get a Sandbox
curl --request GET \
--url https://api.example.com/v2/sandboxes/boxes/{name}import requests
url = "https://api.example.com/v2/sandboxes/boxes/{name}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v2/sandboxes/boxes/{name}', 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.example.com/v2/sandboxes/boxes/{name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v2/sandboxes/boxes/{name}"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v2/sandboxes/boxes/{name}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/sandboxes/boxes/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"template_name": "<string>",
"status": "provisioning",
"status_message": "<string>",
"dataplane_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}{
"detail": {
"error": "NotFound",
"message": "Resource not found."
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Path Parameters
Sandbox name
Response
Successful Response
Response model for a SandboxClaim.
Sandbox status: provisioning, ready, or failed
Details about failure when status is 'failed'
Direct URL for data plane operations (execute, files, terminal). Always present once computed, but only functional when status is 'ready'.
Was this page helpful?