Hotspot
Share this machine's network with a Space.
Share this machine's network with a Space.
| Tool | Description |
|---|---|
hotspot_start | Start sharing this machine's network with a Space. |
hotspot_stop | Stop sharing this machine's network. |
hotspot_status | Report which Spaces are sharing this machine's network, with counters. |
Start sharing this machine's network with a Space.
Starts the Space's reverse-SOCKS hotspot (TunnelService.StartHotspot) and serves its egress from this machine, so the Space browses as this machine. Runs until hotspot_stop, delete_space, or this server exiting.
| Providers | all (cloud, local, direct, relay) |
| Platforms | all (macos, windows, linux) |
| Metering | free |
| Approval | permission spaces:hotspot_start; destructive |
| Requires (spacesd) | hotspot |
| Swift SDK | connection.hotspot.start(sharingWith:) |
| Rust | Spaces::hotspot_start |
| Parameter | Type | Default | Description |
|---|---|---|---|
bypass | string[] | none | Destinations (CIDRs or host suffixes) that keep using the Space's own network. |
set_system_proxy | boolean | true | Point the Space's system proxy (and HTTP(S)_PROXY for new processes) at the hotspot. Default true. |
space | string | required | Space id or name. |
JSON: the hotspot (space, state, hotspot_id, socks_address, active_connections, bytes_out, bytes_in, served_here).
invalid_argument, not_found, ambiguous_sandbox, spacesd_not_available, capability_missing
hotspot can borrow this machine's network.Stop sharing this machine's network.
| Providers | all (cloud, local, direct, relay) |
| Platforms | all (macos, windows, linux) |
| Metering | free |
| Approval | permission spaces:hotspot_stop; destructive |
| Requires (spacesd) | hotspot |
| Swift SDK | connection.hotspot.stop() |
| Rust | Spaces::hotspot_stop |
| Parameter | Type | Default | Description |
|---|---|---|---|
space | string | none | Space id or name. Default: every Space with an active hotspot. |
JSON: {"stopped": [...]}, the hotspots that were stopped.
invalid_argument, not_found, ambiguous_sandbox, spacesd_not_available, capability_missing
Report which Spaces are sharing this machine's network, with counters.
| Providers | all (cloud, local, direct, relay) |
| Platforms | all (macos, windows, linux) |
| Metering | free |
| Approval | permission spaces:hotspot_status, in spaces:readonly; read-only, idempotent |
| Requires (spacesd) | hotspot |
| Swift SDK | connection.hotspot.status() |
| Rust | Spaces::hotspot_statuses |
| Parameter | Type | Default | Description |
|---|---|---|---|
space | string | none | Space id or name. Default: every Space with an active hotspot. |
JSON: {"hotspots": [...]}, each shaped like hotspot_start's result.
invalid_argument, not_found, ambiguous_sandbox, spacesd_not_available, capability_missing