Stop sandbox

Interrupts whatever the caller's sandbox is running and answers how many commands it ended.

POST /v1/sandbox/stop

Sandbox → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/sandbox/stop`
Method	`POST`
Operation	`stop_run`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Interrupts whatever the caller's sandbox is running and answers how many commands it ended. The sandbox stays leased — stop ends the WORK, end ends the RESOURCE — so whoever stopped a run can still read what it left behind.

Request

1 field, body application/json (required).

Field	In	Type	Required	Description
`id`	body	string	—	ID is the sandbox to interrupt, from an earlier lease.

Response

Status	Body	Meaning
`200`	sandbox.Stopped	ok
`default`	problem-details	refused

200 body — 1 field.

Field	In	Type	Always	Description
`stopped`	body	integer (int64)	—	Stopped counts the commands that were still running and were interrupted.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo sandbox stop

.ts

.py

.go

.rs

.java

import { Configuration, SandboxApi } from 'hanzoai';

const api = new SandboxApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.stopRun({ 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).stop_run(id="<id>")

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.SandboxAPI.StopRun(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::stop_run(&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).stopRun();

curl -X POST https://api.hanzo.ai/v1/sandbox/stop \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "id": "<id>"
     }'

Tool sandbox, op stop_run — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "sandbox",
         "arguments": {
           "op": "stop_run",
           "input": {
             "id": "<id>"
           }
         }
       }
     }'

Sandbox API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousRun sandbox NextCreate write