List ports

Lists the TCP ports something listens on in a sandbox the caller holds, each with the preview host that serves it — what the sandbox's Browser can open.

GET /v1/sandbox/{id}/ports

Sandbox → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/sandbox/{id}/ports`
Method	`GET`
Operation	`get_sandbox_by_id_ports`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Lists the TCP ports something listens on in a sandbox the caller holds, each with the preview host that serves it — what the sandbox's Browser can open. A dev server started in the sandbox appears here once it listens.

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the sandbox, from the path.

Response

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

200 body — 3 fields.

Field	In	Type	Always	Description
`ports`	body	sandbox.Port[]	—	Ports are the listening ports, ascending.
`ports[].host`	body	string	—	Host is the preview host that serves it, the same for as long as the sandbox lives, parked or running.
`ports[].port`	body	integer (int64)	—	Port is the TCP port.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

.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.getSandboxByIdPorts({ 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).get_sandbox_by_id_ports(id='id')

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

resp, _, err := client.SandboxAPI.GetSandboxByIdPorts(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::get_sandbox_by_id_ports(&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).getSandboxByIdPorts();

curl https://api.hanzo.ai/v1/sandbox/<id>/ports \
  -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?

PreviousList fs NextList ws — GET /v1/sandbox/{id}/screen/ws