Delete sandbox

Ends a sandbox and releases the compute behind it.

DELETE /v1/sandbox/{id}

Addresshttps://api.hanzo.ai/v1/sandbox/{id}
MethodDELETE
Operationdelete_sandbox_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Ends a sandbox and releases the compute behind it. Answers 204.

ENDING IS NOT STOPPING. This releases the resource: the pod goes and anything only inside it goes with it. To end what a sandbox is RUNNING while keeping the sandbox — the checkout, the logs, the half-written file — the verb is POST /v1/sandbox/stop.

?purge=1 additionally removes the record, so the sandbox stops being listed at all rather than being listed as ended.

Request

2 fields.

FieldInTypeRequiredDescription
idpathstringyesID is the sandbox to end, from the path.
purgequerystring—

Response

StatusBodyMeaning
204—no content
defaultproblem-detailsrefused

Failure carries the platform error shape — see Errors.

Examples

hanzo sandbox rm <id>
import { Configuration, SandboxApi } from 'hanzoai';

const api = new SandboxApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.deleteSandboxById({ id: 'id' });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import SandboxApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = SandboxApi(client).delete_sandbox_by_id(id='id')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.SandboxAPI.DeleteSandboxById(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, sandbox_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = sandbox_api::delete_sandbox_by_id(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.SandboxApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new SandboxApi(client).deleteSandboxById();
curl -X DELETE https://api.hanzo.ai/v1/sandbox/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches sandbox through the sandbox tool, which names its 17 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_sandboxes"
         }
       }
     }'

Sandbox API · All Hanzo APIs · Interactive reference

Was this page useful?