CLI
Fast command-line client for code execution and interactive sessions. 42+ languages, 30+ shells/REPLs.
Official OpenAPI Swagger Docs ↗Quick Start — Python
# Download + setup
curl -O https://git.unturf.com/engineering/unturf/un-inception/-/raw/main/clients/python/sync/src/un.py && chmod +x un.py && ln -sf un.py un
export UNSANDBOX_PUBLIC_KEY="unsb-pk-xxxx-xxxx-xxxx-xxxx"
export UNSANDBOX_SECRET_KEY="unsb-sk-xxxxx-xxxxx-xxxxx-xxxxx"
# Run code
./un script.py
Downloads
Install Guide →Features
- 42+ languages - Python, JS, Go, Rust, C++, Java...
- Sessions - 30+ shells/REPLs, tmux persistence
- Files - Upload files, collect artifacts
- Services - Persistent containers with domains
- Snapshots - Point-in-time backups
- Images - Publish, share, transfer
Integration Quickstart ⚡
Add unsandbox superpowers to your existing Python app:
curl -O https://git.unturf.com/engineering/unturf/un-inception/-/raw/main/clients/python/sync/src/un.py
# Option A: Environment variables
export UNSANDBOX_PUBLIC_KEY="unsb-pk-xxxx-xxxx-xxxx-xxxx"
export UNSANDBOX_SECRET_KEY="unsb-sk-xxxxx-xxxxx-xxxxx-xxxxx"
# Option B: Config file (persistent)
mkdir -p ~/.unsandbox
echo "unsb-pk-xxxx-xxxx-xxxx-xxxx,unsb-sk-xxxxx-xxxxx-xxxxx-xxxxx" > ~/.unsandbox/accounts.csv
# In your Python app:
from un import execute_code
result = execute_code("python", "print('Hello from Python running on unsandbox!')")
print(result["stdout"]) # Hello from Python running on unsandbox!
python3 myapp.py
4e1cef859877244ec90d7b4b95146cbe
SHA256: 07fe5276b2948192a7eda2ce2aec0cbf14b47546f078c43661191d3907d676d3
#!/usr/bin/env python3
"""
PUBLIC DOMAIN - NO LICENSE, NO WARRANTY
unsandbox.com Python SDK (Synchronous)
Library Usage:
from un import (
# Execution (8)
execute_code,
execute_async,
get_job,
wait_for_job,
cancel_job,
list_jobs,
get_languages,
detect_language,
# Sessions (9)
list_sessions,
get_session,
create_session,
delete_session,
freeze_session,
unfreeze_session,
boost_session,
unboost_session,
shell_session,
# Services (17)
list_services,
create_service,
get_service,
update_service,
delete_service,
freeze_service,
unfreeze_service,
lock_service,
unlock_service,
set_unfreeze_on_demand,
set_show_freeze_page,
get_service_logs,
get_service_env,
set_service_env,
delete_service_env,
export_service_env,
redeploy_service,
execute_in_service,
resize_service,
# Snapshots (9)
session_snapshot,
service_snapshot,
list_snapshots,
get_snapshot,
restore_snapshot,
delete_snapshot,
lock_snapshot,
unlock_snapshot,
clone_snapshot,
# Images (13)
image_publish,
list_images,
get_image,
delete_image,
lock_image,
unlock_image,
set_image_visibility,
grant_image_access,
revoke_image_access,
list_image_trusted,
transfer_image,
spawn_from_image,
clone_image,
# PaaS Logs (2)
logs_fetch,
logs_stream,
# Key validation
validate_keys,
# Utilities
version,
health_check,
last_error,
hmac_sign,
# Image generation (AI)
image,
)
# Execute code synchronously
result = execute_code("python", 'print("hello")', public_key, secret_key)
# Execute asynchronously
job_id = execute_async("javascript", 'console.log("hello")', public_key, secret_key)
# Wait for job completion with exponential backoff
result = wait_for_job(job_id, public_key, secret_key)
# List all jobs
jobs = list_jobs(public_key, secret_key)
# Get supported languages
languages = get_languages(public_key, secret_key)
# Detect language from filename
lang = detect_language("script.py") # Returns "python"
# Snapshot operations
snapshot_id = session_snapshot(session_id, public_key, secret_key, name="my-snapshot")
snapshot_id = service_snapshot(service_id, public_key, secret_key, name="svc-snapshot")
snapshots = list_snapshots(public_key, secret_key)
result = restore_snapshot(snapshot_id, public_key, secret_key)
delete_snapshot(snapshot_id, public_key, secret_key)
Authentication Priority (4-tier):
1. Function arguments (public_key, secret_key)
2. Environment variables (UNSANDBOX_PUBLIC_KEY, UNSANDBOX_SECRET_KEY)
3. Config file (~/.unsandbox/accounts.csv, line 0 by default)
4. Local directory (./accounts.csv, line 0 by default)
Format: public_key,secret_key (one per line)
Account selection: UNSANDBOX_ACCOUNT=N env var (0-based index)
Request Authentication (HMAC-SHA256):
Authorization: Bearer <public_key> (identifies account)
X-Timestamp: <unix_seconds> (replay prevention)
X-Signature: HMAC-SHA256(secret_key, msg) (proves secret + body integrity)
Message format: "timestamp:METHOD:path:body"
- timestamp: seconds since epoch
- METHOD: GET, POST, DELETE, etc. (uppercase)
- path: e.g., "/execute", "/jobs/123"
- body: JSON payload (empty string for GET/DELETE)
Languages Cache:
- Cached in ~/.unsandbox/languages.json
- TTL: 1 hour
- Updated on successful API calls
"""
import hashlib
import hmac
import json
import os
import time
from datetime import datetime, timedelta
from pathlib import Path
from typing import Optional, Dict, Any, List
try:
import requests
REQUESTS_AVAILABLE = True
except ImportError:
REQUESTS_AVAILABLE = False
requests = None # type: ignore
API_BASE = "https://api.unsandbox.com"
POLL_DELAYS_MS = [300, 450, 700, 900, 650, 1600, 2000]
LANGUAGES_CACHE_TTL = 3600 # 1 hour
class CredentialsError(Exception):
"""Raised when credentials cannot be found or are invalid."""
class DependencyError(Exception):
"""Raised when a required dependency is not installed."""
pass
def _check_requests():
"""Check if requests is available, raise helpful error if not."""
if not REQUESTS_AVAILABLE:
raise DependencyError(
"requests is required for HTTP operations. "
"Install with: pip install requests"
)
pass
def _get_unsandbox_dir() -> Path:
"""Get ~/.unsandbox directory path, creating if necessary."""
home = Path.home()
unsandbox_dir = home / ".unsandbox"
unsandbox_dir.mkdir(exist_ok=True, mode=0o700)
return unsandbox_dir
def _load_credentials_from_csv(csv_path: Path, account_index: int = 0) -> Optional[tuple[str, str]]:
"""Load credentials from CSV file (public_key,secret_key per line)."""
if not csv_path.exists():
return None
try:
with open(csv_path, "r") as f:
for i, line in enumerate(f):
line = line.strip()
if not line or line.startswith("#"):
continue
if i == account_index:
parts = line.split(",")
if len(parts) >= 2:
return (parts[0].strip(), parts[1].strip())
return None
except Exception:
return None
def _resolve_credentials(
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
account_index: Optional[int] = None,
) -> tuple[str, str]:
"""
Resolve credentials from 4-tier priority system.
Priority:
1. Function arguments
2. Environment variables
3. ~/.unsandbox/accounts.csv
4. ./accounts.csv
"""
# Tier 1: Function arguments
if public_key and secret_key:
return (public_key, secret_key)
# Tier 2: Environment variables
env_pk = os.environ.get("UNSANDBOX_PUBLIC_KEY")
env_sk = os.environ.get("UNSANDBOX_SECRET_KEY")
if env_pk and env_sk:
return (env_pk, env_sk)
# Determine account index
if account_index is None:
account_index = int(os.environ.get("UNSANDBOX_ACCOUNT", "0"))
# Tier 3: ~/.unsandbox/accounts.csv
unsandbox_dir = _get_unsandbox_dir()
creds = _load_credentials_from_csv(unsandbox_dir / "accounts.csv", account_index)
if creds:
return creds
# Tier 4: ./accounts.csv
creds = _load_credentials_from_csv(Path("accounts.csv"), account_index)
if creds:
return creds
raise CredentialsError(
"No credentials found. Please provide via:\n"
" 1. Function arguments (public_key, secret_key)\n"
" 2. Environment variables (UNSANDBOX_PUBLIC_KEY, UNSANDBOX_SECRET_KEY)\n"
" 3. ~/.unsandbox/accounts.csv\n"
" 4. ./accounts.csv"
)
def _sign_request(
secret_key: str,
timestamp: int,
method: str,
path: str,
body: Optional[str] = None,
) -> str:
"""
Sign a request using HMAC-SHA256.
Message format: "timestamp:METHOD:path:body"
Returns: 64-character hex string
"""
body_str = body or ""
message = f"{timestamp}:{method}:{path}:{body_str}"
signature = hmac.new(
secret_key.encode(),
message.encode(),
hashlib.sha256,
).hexdigest()
return signature
def _make_request(
method: str,
path: str,
public_key: str,
secret_key: str,
data: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""
Make an authenticated HTTP request to the API.
Raises requests.RequestException on network errors.
Raises ValueError if response is not valid JSON.
Raises DependencyError if requests is not installed.
"""
_check_requests()
url = f"{API_BASE}{path}"
timestamp = int(time.time())
body = json.dumps(data) if data else ""
signature = _sign_request(secret_key, timestamp, method, path, body if data else None)
headers = {
"Authorization": f"Bearer {public_key}",
"X-Timestamp": str(timestamp),
"X-Signature": signature,
"Content-Type": "application/json",
}
if method == "GET":
response = requests.get(url, headers=headers, timeout=120)
elif method == "POST":
response = requests.post(url, headers=headers, json=data, timeout=120)
elif method == "PATCH":
response = requests.patch(url, headers=headers, json=data, timeout=120)
elif method == "DELETE":
response = requests.delete(url, headers=headers, timeout=120)
else:
raise ValueError(f"Unsupported HTTP method: {method}")
response.raise_for_status()
return response.json()
def _make_request_with_sudo(
method: str,
path: str,
public_key: str,
secret_key: str,
data: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""
Make an authenticated HTTP request with sudo OTP challenge handling.
If the server returns 428 (Precondition Required), prompts for OTP
and retries the request with X-Sudo-OTP and X-Sudo-Challenge headers.
Used for destructive operations: service destroy/unlock, snapshot delete/unlock,
image delete/unlock.
"""
import sys
url = f"{API_BASE}{path}"
timestamp = int(time.time())
body = json.dumps(data) if data else ""
signature = _sign_request(secret_key, timestamp, method, path, body if data else None)
headers = {
"Authorization": f"Bearer {public_key}",
"X-Timestamp": str(timestamp),
"X-Signature": signature,
"Content-Type": "application/json",
}
if method == "GET":
response = requests.get(url, headers=headers, timeout=120)
elif method == "POST":
response = requests.post(url, headers=headers, json=data, timeout=120)
elif method == "PATCH":
response = requests.patch(url, headers=headers, json=data, timeout=120)
elif method == "DELETE":
response = requests.delete(url, headers=headers, timeout=120)
else:
raise ValueError(f"Unsupported HTTP method: {method}")
# Handle 428 sudo OTP challenge
if response.status_code == 428:
try:
challenge_data = response.json()
challenge_id = challenge_data.get("challenge_id", "")
except (ValueError, KeyError):
challenge_id = ""
print("\033[33mConfirmation required. Check your email for a one-time code.\033[0m", file=sys.stderr)
try:
otp = input("Enter OTP: ").strip()
except (EOFError, KeyboardInterrupt):
raise ValueError("Operation cancelled")
if not otp:
raise ValueError("Operation cancelled")
# Retry with sudo headers
retry_timestamp = int(time.time())
retry_signature = _sign_request(secret_key, retry_timestamp, method, path, body if data else None)
retry_headers = {
"Authorization": f"Bearer {public_key}",
"X-Timestamp": str(retry_timestamp),
"X-Signature": retry_signature,
"Content-Type": "application/json",
"X-Sudo-OTP": otp,
"X-Sudo-Challenge": challenge_id,
}
if method == "GET":
response = requests.get(url, headers=retry_headers, timeout=120)
elif method == "POST":
response = requests.post(url, headers=retry_headers, json=data, timeout=120)
elif method == "PATCH":
response = requests.patch(url, headers=retry_headers, json=data, timeout=120)
elif method == "DELETE":
response = requests.delete(url, headers=retry_headers, timeout=120)
response.raise_for_status()
return response.json()
def _get_languages_cache_path() -> Path:
"""Get path to languages cache file."""
return _get_unsandbox_dir() / "languages.json"
def _load_languages_cache() -> Optional[List[str]]:
"""Load languages from cache if valid (< 1 hour old)."""
cache_path = _get_languages_cache_path()
if not cache_path.exists():
return None
try:
with open(cache_path, "r") as f:
data = json.load(f)
# Check if cache is fresh
mtime = cache_path.stat().st_mtime
age_seconds = time.time() - mtime
if age_seconds < LANGUAGES_CACHE_TTL:
return data.get("languages")
except Exception:
pass
return None
def _save_languages_cache(languages: List[str]) -> None:
"""Save languages to cache."""
try:
cache_path = _get_languages_cache_path()
with open(cache_path, "w") as f:
json.dump({"languages": languages, "timestamp": int(time.time())}, f)
except Exception:
pass # Cache failures are non-fatal
def execute_code(
language: str,
code: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Execute code synchronously (blocks until completion).
Args:
language: Programming language (e.g., "python", "javascript", "go")
code: Source code to execute
public_key: Optional API key (uses credentials resolution if not provided)
secret_key: Optional API secret (uses credentials resolution if not provided)
Returns:
Response dict containing stdout, stderr, exit code, etc.
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
response = _make_request(
"POST",
"/execute",
public_key,
secret_key,
{"language": language, "code": code},
)
# If we got a job_id, poll until completion
job_id = response.get("job_id")
status = response.get("status")
if job_id and status in ("pending", "running"):
return wait_for_job(job_id, public_key, secret_key)
return response
def execute_async(
language: str,
code: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> str:
"""
Execute code asynchronously (returns immediately with job_id).
Args:
language: Programming language (e.g., "python", "javascript")
code: Source code to execute
public_key: Optional API key
secret_key: Optional API secret
Returns:
Job ID string
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
response = _make_request(
"POST",
"/execute",
public_key,
secret_key,
{"language": language, "code": code},
)
return response.get("job_id")
def get_job(
job_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Get current status/result of a job (single poll, no waiting).
Args:
job_id: Job ID from execute_async()
public_key: Optional API key
secret_key: Optional API secret
Returns:
Job response dict
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("GET", f"/jobs/{job_id}", public_key, secret_key)
def wait_for_job(
job_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
timeout: Optional[float] = None,
) -> Dict[str, Any]:
"""
Wait for job completion with exponential backoff polling.
Polling delays (ms): [300, 450, 700, 900, 650, 1600, 2000, ...]
Cumulative: 300, 750, 1450, 2350, 3000, 4600, 6600ms+
Args:
job_id: Job ID from execute_async()
public_key: Optional API key
secret_key: Optional API secret
timeout: Optional maximum wait time in seconds (None = wait indefinitely)
Returns:
Final job result when status is terminal (completed, failed, timeout, cancelled)
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
TimeoutError: If timeout is exceeded before job completes
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
poll_count = 0
start_time = time.time()
while True:
# Check timeout
if timeout is not None:
elapsed = time.time() - start_time
if elapsed >= timeout:
raise TimeoutError(f"Job {job_id} did not complete within {timeout} seconds")
# Sleep before polling
delay_idx = min(poll_count, len(POLL_DELAYS_MS) - 1)
time.sleep(POLL_DELAYS_MS[delay_idx] / 1000.0)
poll_count += 1
response = get_job(job_id, public_key, secret_key)
status = response.get("status")
if status in ("completed", "failed", "timeout", "cancelled"):
return response
# Still running, continue polling
def cancel_job(
job_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Cancel a running job.
Args:
job_id: Job ID to cancel
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with cancellation confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("DELETE", f"/jobs/{job_id}", public_key, secret_key)
def list_jobs(
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> List[Dict[str, Any]]:
"""
List all jobs for the authenticated account.
Args:
public_key: Optional API key
secret_key: Optional API secret
Returns:
List of job dicts
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
response = _make_request("GET", "/jobs", public_key, secret_key)
return response.get("jobs", [])
def get_languages(
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> List[str]:
"""
Get list of supported programming languages.
Results are cached for 1 hour in ~/.unsandbox/languages.json
Args:
public_key: Optional API key
secret_key: Optional API secret
Returns:
List of language identifiers (e.g., ["python", "javascript", "go", ...])
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
# Try cache first
cached = _load_languages_cache()
if cached:
return cached
public_key, secret_key = _resolve_credentials(public_key, secret_key)
response = _make_request("GET", "/languages", public_key, secret_key)
languages = response.get("languages", [])
# Cache the result
_save_languages_cache(languages)
return languages
# Language detection mapping (file extension -> language)
_LANGUAGE_MAP = {
"py": "python",
"js": "javascript",
"ts": "typescript",
"rb": "ruby",
"php": "php",
"pl": "perl",
"sh": "bash",
"r": "r",
"R": "r",
"lua": "lua",
"go": "go",
"rs": "rust",
"c": "c",
"cpp": "cpp",
"cc": "cpp",
"cxx": "cpp",
"java": "java",
"kt": "kotlin",
"m": "objc",
"cs": "csharp",
"fs": "fsharp",
"hs": "haskell",
"ml": "ocaml",
"clj": "clojure",
"scm": "scheme",
"ss": "scheme",
"erl": "erlang",
"ex": "elixir",
"exs": "elixir",
"jl": "julia",
"d": "d",
"nim": "nim",
"zig": "zig",
"v": "v",
"cr": "crystal",
"dart": "dart",
"groovy": "groovy",
"f90": "fortran",
"f95": "fortran",
"lisp": "commonlisp",
"lsp": "commonlisp",
"cob": "cobol",
"tcl": "tcl",
"raku": "raku",
"pro": "prolog",
"p": "prolog",
"4th": "forth",
"forth": "forth",
"fth": "forth",
}
def detect_language(filename: str) -> Optional[str]:
"""
Detect programming language from filename extension.
Args:
filename: Filename to detect language from (e.g., "script.py")
Returns:
Language identifier (e.g., "python") or None if unknown
Examples:
detect_language("hello.py") # -> "python"
detect_language("script.js") # -> "javascript"
detect_language("main.go") # -> "go"
detect_language("unknown") # -> None
"""
if not filename or "." not in filename:
return None
ext = filename.rsplit(".", 1)[-1].lower()
return _LANGUAGE_MAP.get(ext)
def session_snapshot(
session_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
name: Optional[str] = None,
ephemeral: bool = False,
) -> str:
"""
Create a snapshot of a session.
Args:
session_id: Session ID to snapshot
public_key: Optional API key
secret_key: Optional API secret
name: Optional snapshot name
ephemeral: If True, snapshot is temporary and may be auto-deleted
Returns:
Snapshot ID
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
data = {"session_id": session_id, "ephemeral": ephemeral}
if name:
data["name"] = name
response = _make_request("POST", "/snapshots", public_key, secret_key, data)
return response.get("snapshot_id")
def service_snapshot(
service_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
name: Optional[str] = None,
) -> str:
"""
Create a snapshot of a service.
Args:
service_id: Service ID to snapshot
public_key: Optional API key
secret_key: Optional API secret
name: Optional snapshot name
Returns:
Snapshot ID
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
data = {"service_id": service_id}
if name:
data["name"] = name
response = _make_request("POST", "/snapshots", public_key, secret_key, data)
return response.get("snapshot_id")
def list_snapshots(
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> List[Dict[str, Any]]:
"""
List all snapshots.
Args:
public_key: Optional API key
secret_key: Optional API secret
Returns:
List of snapshot dicts
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
response = _make_request("GET", "/snapshots", public_key, secret_key)
return response.get("snapshots", [])
def get_snapshot(
snapshot_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Get details of a specific snapshot.
Args:
snapshot_id: Snapshot ID to get details for
public_key: Optional API key
secret_key: Optional API secret
Returns:
Snapshot details dict containing:
- id: Snapshot ID
- name: Snapshot name
- type: "session" or "service"
- source_id: Original resource ID
- hot: Whether snapshot preserves running state
- locked: Whether snapshot is locked
- created_at: Creation timestamp
- size_bytes: Size in bytes
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("GET", f"/snapshots/{snapshot_id}", public_key, secret_key)
def restore_snapshot(
snapshot_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Restore a snapshot (NEW).
Args:
snapshot_id: Snapshot ID to restore
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with restored resource info
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/snapshots/{snapshot_id}/restore", public_key, secret_key, {})
def delete_snapshot(
snapshot_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Delete a snapshot (NEW).
Args:
snapshot_id: Snapshot ID to delete
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with deletion confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request_with_sudo("DELETE", f"/snapshots/{snapshot_id}", public_key, secret_key)
# =============================================================================
# Session Management Functions
# =============================================================================
def list_sessions(
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> List[Dict[str, Any]]:
"""
List all sessions for the authenticated account.
Args:
public_key: Optional API key
secret_key: Optional API secret
Returns:
List of session dicts containing id, container_name, status, etc.
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
response = _make_request("GET", "/sessions", public_key, secret_key)
return response.get("sessions", [])
def get_session(
session_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Get details of a specific session.
Args:
session_id: Session ID to get details for
public_key: Optional API key
secret_key: Optional API secret
Returns:
Session details dict
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("GET", f"/sessions/{session_id}", public_key, secret_key)
def create_session(
language: Optional[str] = None,
network_mode: str = "zerotrust",
ttl: int = 3600,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
shell: Optional[str] = None,
multiplexer: Optional[str] = None,
vcpu: int = 1,
) -> Dict[str, Any]:
"""
Create a new interactive session.
Args:
language: Optional programming language for the session
network_mode: Network mode - "zerotrust" (default, no network) or "semitrusted" (with network)
ttl: Time to live in seconds (default 3600)
public_key: Optional API key
secret_key: Optional API secret
shell: Optional shell to use (e.g., "bash", "python3")
multiplexer: Optional terminal multiplexer ("tmux" or "screen")
vcpu: Number of vCPUs (1-8, default 1)
Returns:
Response dict containing session_id, container_name, etc.
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
data: Dict[str, Any] = {
"network_mode": network_mode,
"ttl": ttl,
}
if language:
data["language"] = language
if shell:
data["shell"] = shell
if multiplexer:
data["multiplexer"] = multiplexer
if vcpu > 1:
data["vcpu"] = vcpu
return _make_request("POST", "/sessions", public_key, secret_key, data)
def delete_session(
session_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Delete/terminate a session.
Args:
session_id: Session ID to delete
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with deletion confirmation and optional artifacts
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("DELETE", f"/sessions/{session_id}", public_key, secret_key)
def freeze_session(
session_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Freeze a session (pause execution, preserve state).
Args:
session_id: Session ID to freeze
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with freeze confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/sessions/{session_id}/freeze", public_key, secret_key, {})
def unfreeze_session(
session_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Unfreeze a session (resume execution).
Args:
session_id: Session ID to unfreeze
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with unfreeze confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/sessions/{session_id}/unfreeze", public_key, secret_key, {})
def boost_session(
session_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Boost a session (increase resources).
Args:
session_id: Session ID to boost
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with boost confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/sessions/{session_id}/boost", public_key, secret_key, {})
def unboost_session(
session_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Unboost a session (return to normal resources).
Args:
session_id: Session ID to unboost
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with unboost confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/sessions/{session_id}/unboost", public_key, secret_key, {})
def shell_session(
session_id: str,
command: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Execute a shell command in a session.
Note: This is for one-off commands. For interactive shell access,
use WebSocket connection to /sessions/{id}/shell.
Args:
session_id: Session ID to execute command in
command: Shell command to execute
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with command output
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request(
"POST",
f"/sessions/{session_id}/shell",
public_key,
secret_key,
{"command": command},
)
# =============================================================================
# Service Management Functions
# =============================================================================
def list_services(
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> List[Dict[str, Any]]:
"""
List all services for the authenticated account.
Args:
public_key: Optional API key
secret_key: Optional API secret
Returns:
List of service dicts containing id, name, status, ports, etc.
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
response = _make_request("GET", "/services", public_key, secret_key)
return response.get("services", [])
def create_service(
name: str,
ports: Optional[List[int]] = None,
bootstrap: Optional[str] = None,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
network_mode: str = "semitrusted",
custom_domains: Optional[List[str]] = None,
vcpu: int = 1,
service_type: Optional[str] = None,
unfreeze_on_demand: bool = False,
golden_image: Optional[str] = None,
input_files: Optional[List[Dict[str, str]]] = None,
) -> Dict[str, Any]:
"""
Create a new persistent service.
Args:
name: Service name (used for subdomain: name.on.unsandbox.com)
ports: List of ports to expose (e.g., [80, 443])
bootstrap: Bootstrap script content, URL, or inline command
public_key: Optional API key
secret_key: Optional API secret
network_mode: Network mode (default "semitrusted" for services)
custom_domains: Optional list of custom domain names
vcpu: Number of vCPUs (1-8, default 1)
service_type: Optional service type for SRV records (e.g., "minecraft")
unfreeze_on_demand: If True, automatically unfreeze service on incoming requests
golden_image: Optional LXD image alias (e.g., "golden-alpine-3.21")
input_files: Optional list of dicts with "filename" and "content" (base64)
Returns:
Response dict containing service_id, etc.
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
data: Dict[str, Any] = {
"name": name,
"network_mode": network_mode,
}
if ports:
data["ports"] = ports
if bootstrap:
# Check if it looks like a URL
if bootstrap.startswith("http://") or bootstrap.startswith("https://"):
data["bootstrap"] = bootstrap
else:
data["bootstrap_content"] = bootstrap
if custom_domains:
data["custom_domains"] = custom_domains
if vcpu > 1:
data["vcpu"] = vcpu
if service_type:
data["service_type"] = service_type
if unfreeze_on_demand:
data["unfreeze_on_demand"] = unfreeze_on_demand
if golden_image:
data["golden_image"] = golden_image
if input_files:
data["input_files"] = input_files
return _make_request("POST", "/services", public_key, secret_key, data)
def get_service(
service_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Get details of a specific service.
Args:
service_id: Service ID to get details for
public_key: Optional API key
secret_key: Optional API secret
Returns:
Service details dict
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("GET", f"/services/{service_id}", public_key, secret_key)
def update_service(
service_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
vcpu: Optional[int] = None,
**kwargs,
) -> Dict[str, Any]:
"""
Update a service (e.g., resize vCPU/memory).
Args:
service_id: Service ID to update
public_key: Optional API key
secret_key: Optional API secret
vcpu: Optional new vCPU count (1-8)
**kwargs: Additional fields to update
Returns:
Response dict with update confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
data: Dict[str, Any] = {}
if vcpu is not None:
data["vcpu"] = vcpu
data.update(kwargs)
return _make_request("PATCH", f"/services/{service_id}", public_key, secret_key, data)
def delete_service(
service_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Delete/destroy a service.
Args:
service_id: Service ID to delete
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with deletion confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request_with_sudo("DELETE", f"/services/{service_id}", public_key, secret_key)
def freeze_service(
service_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Freeze a service (pause execution, preserve state).
Args:
service_id: Service ID to freeze
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with freeze confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/services/{service_id}/freeze", public_key, secret_key, {})
def unfreeze_service(
service_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Unfreeze a service (resume execution).
Args:
service_id: Service ID to unfreeze
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with unfreeze confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/services/{service_id}/unfreeze", public_key, secret_key, {})
def lock_service(
service_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Lock a service to prevent accidental deletion.
Args:
service_id: Service ID to lock
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with lock confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/services/{service_id}/lock", public_key, secret_key, {})
def unlock_service(
service_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Unlock a service to allow deletion.
Args:
service_id: Service ID to unlock
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with unlock confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request_with_sudo("POST", f"/services/{service_id}/unlock", public_key, secret_key, {})
def update_service_domains(
service_id: str,
domains: list,
action: str = "custom_domains",
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Update custom domains for a service.
Args:
service_id: Service ID
domains: List of domain strings
action: "custom_domains" (replace), "add" (merge), or "remove" (subtract)
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with updated domains
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("PUT", f"/services/{service_id}/domains", public_key, secret_key, {action: domains})
def set_unfreeze_on_demand(
service_id: str,
enabled: bool,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Enable or disable automatic unfreezing on incoming requests.
When enabled, a frozen service will automatically wake up when it
receives an incoming HTTP request.
Args:
service_id: Service ID to configure
enabled: True to enable auto-unfreeze, False to disable
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with update confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request(
"PATCH",
f"/services/{service_id}",
public_key,
secret_key,
{"unfreeze_on_demand": enabled},
)
def set_show_freeze_page(
service_id: str,
enabled: bool,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Enable or disable freeze page display for a service.
When disabled, frozen services return a JSON error response instead of
displaying the payment/unfreeze page to visitors.
Args:
service_id: Service ID to configure
enabled: True to show freeze page, False to return JSON error
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with update confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request(
"PATCH",
f"/services/{service_id}",
public_key,
secret_key,
{"show_freeze_page": enabled},
)
def get_service_logs(
service_id: str,
all_logs: bool = False,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Get bootstrap/runtime logs for a service.
Args:
service_id: Service ID to get logs for
all_logs: If True, get all logs; if False, get last ~9000 lines (tail)
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict containing "log" field with log content
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
path = f"/services/{service_id}/logs"
if all_logs:
path += "?all=true"
return _make_request("GET", path, public_key, secret_key)
def get_service_env(
service_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Get environment vault status for a service.
Returns metadata about the vault (has_vault, count, updated_at)
but NOT the actual secrets. Use export_service_env to retrieve secrets.
Args:
service_id: Service ID to get env status for
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with has_vault, count, updated_at fields
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("GET", f"/services/{service_id}/env", public_key, secret_key)
def set_service_env(
service_id: str,
env_dict: Dict[str, str],
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Set environment variables for a service.
Replaces the entire environment vault with the provided variables.
Variables are encrypted at rest and injected into the container.
Args:
service_id: Service ID to set env for
env_dict: Dictionary of environment variables (KEY: VALUE)
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with count of variables set
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
# Convert dict to .env format for the API
env_content = "\n".join(f"{k}={v}" for k, v in env_dict.items())
# Note: This endpoint expects text/plain body, but we'll send as JSON
# and let the API handle conversion
return _make_request(
"POST",
f"/services/{service_id}/env",
public_key,
secret_key,
{"env": env_content},
)
def delete_service_env(
service_id: str,
keys: Optional[List[str]] = None,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Delete environment vault or specific keys from a service.
Args:
service_id: Service ID to delete env from
keys: Optional list of specific keys to delete; if None, deletes entire vault
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with deletion confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
path = f"/services/{service_id}/env"
# If specific keys provided, could add as query params (API dependent)
return _make_request("DELETE", path, public_key, secret_key)
def export_service_env(
service_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Export environment vault secrets for a service.
Requires HMAC authentication to prove ownership.
Returns the actual secret values in .env format.
Args:
service_id: Service ID to export env from
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict containing "env" field with KEY=VALUE content
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/services/{service_id}/env/export", public_key, secret_key, {})
def redeploy_service(
service_id: str,
bootstrap: Optional[str] = None,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Redeploy a service (re-run bootstrap script).
Bootstrap scripts should be idempotent for proper upgrade behavior.
Args:
service_id: Service ID to redeploy
bootstrap: Optional new bootstrap script/URL (uses existing if not provided)
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with redeploy confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
data: Dict[str, Any] = {}
if bootstrap:
if bootstrap.startswith("http://") or bootstrap.startswith("https://"):
data["bootstrap"] = bootstrap
else:
data["bootstrap_content"] = bootstrap
return _make_request("POST", f"/services/{service_id}/redeploy", public_key, secret_key, data)
def execute_in_service(
service_id: str,
command: str,
timeout: int = 30000,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Execute a command in a running service container.
Uses async job polling for long-running commands.
Args:
service_id: Service ID to execute command in
command: Shell command to execute
timeout: Command timeout in milliseconds (default 30000)
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with job_id for async polling, or direct result
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request(
"POST",
f"/services/{service_id}/execute",
public_key,
secret_key,
{"command": command, "timeout": timeout},
)
def resize_service(
service_id: str,
vcpu: int,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Resize a service's vCPU allocation.
Args:
service_id: Service ID to resize
vcpu: Number of vCPUs (1-8 typically)
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with updated service info
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request(
"PATCH",
f"/services/{service_id}",
public_key,
secret_key,
{"vcpu": vcpu},
)
# =============================================================================
# Additional Snapshot Functions
# =============================================================================
def lock_snapshot(
snapshot_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Lock a snapshot to prevent accidental deletion.
Args:
snapshot_id: Snapshot ID to lock
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with lock confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/snapshots/{snapshot_id}/lock", public_key, secret_key, {})
def unlock_snapshot(
snapshot_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Unlock a snapshot to allow deletion.
Args:
snapshot_id: Snapshot ID to unlock
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with unlock confirmation
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request_with_sudo("POST", f"/snapshots/{snapshot_id}/unlock", public_key, secret_key, {})
def clone_snapshot(
snapshot_id: str,
clone_type: str = "session",
name: Optional[str] = None,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
shell: Optional[str] = None,
ports: Optional[List[int]] = None,
) -> Dict[str, Any]:
"""
Clone a snapshot to create a new session or service.
Args:
snapshot_id: Snapshot ID to clone from
clone_type: Type of resource to create ("session" or "service")
name: Optional name for the new resource
public_key: Optional API key
secret_key: Optional API secret
shell: Optional shell for session clones
ports: Optional ports list for service clones
Returns:
Response dict containing session_id or service_id
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
data: Dict[str, Any] = {"type": clone_type}
if name:
data["name"] = name
if shell:
data["shell"] = shell
if ports:
data["ports"] = ports
return _make_request("POST", f"/snapshots/{snapshot_id}/clone", public_key, secret_key, data)
# =============================================================================
# Images (LXD Container Images)
# =============================================================================
def image_publish(
source_type: str,
source_id: str,
name: Optional[str] = None,
description: Optional[str] = None,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Publish a service or snapshot as a portable LXD image.
Images are independent of containers and survive service deletion.
They can be shared with other users or made public.
Args:
source_type: Type of source ("service" or "snapshot")
source_id: ID of the service or snapshot to publish
name: Optional friendly name for the image
description: Optional description
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict containing:
- id: Image ID (unsb-image-xxxx-xxxx-xxxx-xxxx)
- name: Image name
- fingerprint: LXD image fingerprint
- size_bytes: Image size in bytes
Example:
>>> img = image_publish("service", "unsb-service-xxxx")
>>> print(img["id"])
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
data: Dict[str, Any] = {"source_type": source_type, "source_id": source_id}
if name:
data["name"] = name
if description:
data["description"] = description
return _make_request("POST", "/images", public_key, secret_key, data)
def list_images(
filter_type: Optional[str] = None,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
List images accessible to this API key.
By default lists all accessible images (owned + shared + public).
Use filter_type to narrow results.
Args:
filter_type: Optional filter - "owned", "shared", or "public"
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict containing:
- images: List of image objects
- count: Total number of images
Example:
>>> result = list_images()
>>> for img in result["images"]:
... print(f"{img['id']}: {img['name']} ({img['access']})")
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
endpoint = "/images"
if filter_type:
endpoint = f"/images/{filter_type}"
return _make_request("GET", endpoint, public_key, secret_key)
def get_image(
image_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Get details of a specific image.
Args:
image_id: Image ID
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict containing image details:
- id, name, description, fingerprint
- source_type, source_id
- size_bytes, locked, visibility
- trusted_keys, created_at
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("GET", f"/images/{image_id}", public_key, secret_key)
def delete_image(
image_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Delete an image.
Cannot delete locked images - unlock first.
Args:
image_id: Image ID to delete
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with deletion confirmation
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request_with_sudo("DELETE", f"/images/{image_id}", public_key, secret_key)
def lock_image(
image_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Lock an image to prevent accidental deletion.
Args:
image_id: Image ID to lock
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with lock status
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/images/{image_id}/lock", public_key, secret_key, {})
def unlock_image(
image_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Unlock an image to allow deletion.
Args:
image_id: Image ID to unlock
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with unlock confirmation
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request_with_sudo("POST", f"/images/{image_id}/unlock", public_key, secret_key, {})
def set_image_visibility(
image_id: str,
visibility: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Set image visibility.
Args:
image_id: Image ID
visibility: One of "private", "unlisted", or "public"
- private: Only owner can see/use
- unlisted: Hidden but can be shared via trusted_keys
- public: Visible to all users (marketplace)
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with updated image info
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/images/{image_id}/visibility", public_key, secret_key, {"visibility": visibility})
def grant_image_access(
image_id: str,
trusted_api_key: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Grant access to an image for another API key.
Works for private/unlisted images. Public images are already accessible.
Args:
image_id: Image ID
trusted_api_key: Public key of the user to grant access
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with updated trusted_keys list
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/images/{image_id}/grant", public_key, secret_key, {"trusted_api_key": trusted_api_key})
def revoke_image_access(
image_id: str,
trusted_api_key: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Revoke access to an image from another API key.
Args:
image_id: Image ID
trusted_api_key: Public key of the user to revoke access
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with updated trusted_keys list
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/images/{image_id}/revoke", public_key, secret_key, {"trusted_api_key": trusted_api_key})
def list_image_trusted(
image_id: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
List all API keys that have access to an image.
Args:
image_id: Image ID
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict containing:
- trusted_keys: List of API public keys with access
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("GET", f"/images/{image_id}/trusted", public_key, secret_key)
def transfer_image(
image_id: str,
to_api_key: str,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Transfer image ownership to another API key.
This is a database-only operation - the LXD image stays on the same node.
Args:
image_id: Image ID to transfer
to_api_key: Public key of the recipient
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with updated owner info
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
return _make_request("POST", f"/images/{image_id}/transfer", public_key, secret_key, {"to_api_key": to_api_key})
def spawn_from_image(
image_id: str,
name: Optional[str] = None,
ports: Optional[List[int]] = None,
bootstrap: Optional[str] = None,
network_mode: str = "zerotrust",
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Create a new service from an image.
Spawns a new container using the image as the base.
Args:
image_id: Image ID to spawn from
name: Optional service name
ports: Optional list of ports to expose
bootstrap: Optional bootstrap script (image may already have app)
network_mode: "zerotrust" or "semitrusted"
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict containing service info with source_image field
Example:
>>> svc = spawn_from_image("unsb-image-xxxx", name="my-app", ports=[8080])
>>> print(svc["service_id"])
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
data: Dict[str, Any] = {"network_mode": network_mode}
if name:
data["name"] = name
if ports:
data["ports"] = ports
if bootstrap:
data["bootstrap"] = bootstrap
return _make_request("POST", f"/images/{image_id}/spawn", public_key, secret_key, data)
def clone_image(
image_id: str,
name: Optional[str] = None,
description: Optional[str] = None,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Clone an image to create a copy owned by you.
The clone inherits the source image's content but:
- Gets a new unique ID
- Is owned by the requesting user
- Starts as private visibility
- Has empty trusted_keys
Args:
image_id: Image ID to clone
name: Optional name for the clone
description: Optional description
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict containing new image info
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
data: Dict[str, Any] = {}
if name:
data["name"] = name
if description:
data["description"] = description
return _make_request("POST", f"/images/{image_id}/clone", public_key, secret_key, data)
# =============================================================================
# Key Validation
# =============================================================================
PORTAL_BASE = "https://unsandbox.com"
def validate_keys(
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Validate API keys against the portal.
Checks if the keys are valid, not expired, and not suspended.
Args:
public_key: Optional API key
secret_key: Optional API secret
Returns:
Response dict with validation result:
- valid: True if keys are valid
- tier: Account tier level
- expires_at: Expiration timestamp (if applicable)
- reason: Reason for invalid status (if applicable)
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
url = f"{API_BASE}/keys/validate"
timestamp = int(time.time())
body = ""
signature = _sign_request(secret_key, timestamp, "POST", "/keys/validate", body)
headers = {
"Authorization": f"Bearer {public_key}",
"X-Timestamp": str(timestamp),
"X-Signature": signature,
"Content-Type": "application/json",
}
response = requests.post(url, headers=headers, data=body, timeout=30)
response.raise_for_status()
return response.json()
# =============================================================================
# Image Generation
# =============================================================================
def image(
prompt: str,
*,
model: str = None,
size: str = "1024x1024",
quality: str = "standard",
n: int = 1,
public_key: str = None,
secret_key: str = None,
) -> Dict[str, Any]:
"""
Generate images from text prompt using AI.
Args:
prompt: Text description of the image to generate
model: Model to use (optional, uses default)
size: Image size (e.g., "1024x1024", "512x512")
quality: "standard" or "hd"
n: Number of images to generate
public_key: API public key (optional)
secret_key: API secret key (optional)
Returns:
dict with keys: images (list of base64 or URLs), created_at
Example:
>>> result = image("A sunset over mountains")
>>> print(result["images"][0])
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
payload = {
"prompt": prompt,
"size": size,
"quality": quality,
"n": n,
}
if model:
payload["model"] = model
return _make_request("POST", "/image", public_key, secret_key, payload)
# =============================================================================
# PaaS Logs Functions
# =============================================================================
_last_error: Optional[str] = None
def logs_fetch(
source: str = "all",
lines: int = 100,
since: str = "5m",
grep: Optional[str] = None,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> Dict[str, Any]:
"""
Fetch batch logs from the PaaS platform.
Args:
source: Log source - "all", "api", "portal", "pool/cammy", "pool/ai"
lines: Number of lines to fetch (1-10000)
since: Time window - "1m", "5m", "1h", "1d"
grep: Optional filter pattern
public_key: Optional API key
secret_key: Optional API secret
Returns:
Dict with log entries
Raises:
requests.RequestException: Network errors
ValueError: Invalid response format
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
params = f"?source={source}&lines={lines}&since={since}"
if grep:
params += f"&grep={grep}"
return _make_request("GET", f"/logs{params}", public_key, secret_key)
def logs_stream(
source: str = "all",
grep: Optional[str] = None,
callback=None,
public_key: Optional[str] = None,
secret_key: Optional[str] = None,
) -> None:
"""
Stream logs via Server-Sent Events.
Blocks until interrupted or server closes connection.
Args:
source: Log source - "all", "api", "portal", "pool/cammy", "pool/ai"
grep: Optional filter pattern
callback: Function called for each log line (signature: callback(source, line))
public_key: Optional API key
secret_key: Optional API secret
Raises:
requests.RequestException: Network errors
CredentialsError: Missing credentials
"""
public_key, secret_key = _resolve_credentials(public_key, secret_key)
url = f"{API_BASE}/logs/stream?source={source}"
if grep:
url += f"&grep={grep}"
timestamp = int(time.time())
path = f"/logs/stream?source={source}"
if grep:
path += f"&grep={grep}"
signature = _sign_request(secret_key, timestamp, "GET", path, None)
headers = {
"Authorization": f"Bearer {public_key}",
"X-Timestamp": str(timestamp),
"X-Signature": signature,
"Accept": "text/event-stream",
}
with requests.get(url, headers=headers, stream=True, timeout=None) as response:
response.raise_for_status()
for line in response.iter_lines():
if line:
decoded = line.decode("utf-8")
if decoded.startswith("data: "):
data = decoded[6:]
try:
entry = json.loads(data)
if callback:
callback(entry.get("source", source), entry.get("line", data))
else:
print(f"[{entry.get('source', source)}] {entry.get('line', data)}")
except json.JSONDecodeError:
if callback:
callback(source, data)
else:
print(f"[{source}] {data}")
# =============================================================================
# Utility Functions
# =============================================================================
SDK_VERSION = "4.2.0"
def version() -> str:
"""
Get the SDK version string.
Returns:
Version string (e.g., "4.2.0")
"""
return SDK_VERSION
def health_check() -> bool:
"""
Check if the API is healthy and responding.
Returns:
True if API is healthy, False otherwise
"""
global _last_error
try:
response = requests.get(f"{API_BASE}/health", timeout=10)
if response.status_code == 200:
return True
_last_error = f"Health check failed: HTTP {response.status_code}"
return False
except Exception as e:
_last_error = f"Health check failed: {str(e)}"
return False
def last_error() -> Optional[str]:
"""
Get the last error message.
Returns:
Last error message or None
"""
return _last_error
def hmac_sign(secret_key: str, message: str) -> str:
"""
Sign a message using HMAC-SHA256.
This is the underlying signing function used for request authentication.
Exposed for testing and debugging purposes.
Args:
secret_key: The secret key for signing
message: The message to sign
Returns:
64-character lowercase hex string
"""
return hmac.new(
secret_key.encode(),
message.encode(),
hashlib.sha256,
).hexdigest()
# =============================================================================
# CLI Implementation
# =============================================================================
import sys
import argparse
def _parse_env_file(file_path: str) -> Dict[str, str]:
"""Parse a .env file into a dictionary."""
env_dict = {}
try:
with open(file_path, "r") as f:
for line in f:
line = line.strip()
if not line or line.startswith("#"):
continue
if "=" in line:
key, _, value = line.partition("=")
# Handle quoted values
value = value.strip()
if (value.startswith('"') and value.endswith('"')) or \
(value.startswith("'") and value.endswith("'")):
value = value[1:-1]
env_dict[key.strip()] = value
except Exception as e:
print(f"Error: Failed to parse env file: {e}", file=sys.stderr)
sys.exit(1)
return env_dict
def _format_list_output(items: List[Dict[str, Any]], resource_type: str) -> str:
"""Format list output in table format."""
if not items:
return f"No {resource_type}s found."
# Determine columns based on resource type
if resource_type == "session":
headers = ["ID", "STATUS", "SHELL", "CREATED"]
rows = []
for item in items:
rows.append([
item.get("id", item.get("session_id", ""))[:36],
item.get("status", "unknown"),
item.get("shell", "bash"),
item.get("created_at", "")[:19] if item.get("created_at") else "",
])
elif resource_type == "service":
headers = ["ID", "NAME", "STATUS", "PORTS", "CREATED"]
rows = []
for item in items:
ports = item.get("ports", [])
ports_str = ",".join(str(p) for p in ports) if ports else ""
rows.append([
item.get("id", item.get("service_id", ""))[:36],
item.get("name", "")[:20],
item.get("status", "unknown"),
ports_str[:15],
item.get("created_at", "")[:19] if item.get("created_at") else "",
])
elif resource_type == "snapshot":
headers = ["ID", "NAME", "TYPE", "SIZE", "CREATED"]
rows = []
for item in items:
rows.append([
item.get("id", item.get("snapshot_id", ""))[:36],
item.get("name", "")[:20],
item.get("source_type", "unknown"),
item.get("size", ""),
item.get("created_at", "")[:19] if item.get("created_at") else "",
])
elif resource_type == "image":
headers = ["ID", "NAME", "VISIBILITY", "SOURCE", "CREATED"]
rows = []
for item in items:
rows.append([
item.get("id", item.get("image_id", ""))[:36],
item.get("name", "")[:20],
item.get("visibility", "private"),
item.get("source_type", "")[:10],
item.get("created_at", "")[:19] if item.get("created_at") else "",
])
else:
headers = ["ID", "STATUS"]
rows = [[str(item.get("id", "")), str(item.get("status", ""))] for item in items]
# Calculate column widths
widths = [len(h) for h in headers]
for row in rows:
for i, cell in enumerate(row):
widths[i] = max(widths[i], len(str(cell)))
# Build output
lines = []
header_line = " ".join(h.ljust(widths[i]) for i, h in enumerate(headers))
lines.append(header_line)
for row in rows:
line = " ".join(str(cell).ljust(widths[i]) for i, cell in enumerate(row))
lines.append(line)
return "\n".join(lines)
def _build_parser() -> argparse.ArgumentParser:
"""Build the argument parser for the CLI."""
parser = argparse.ArgumentParser(
prog="un.py",
description="Unsandbox CLI - Execute code in secure containers",
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog="""
Examples:
python un.py script.py Execute Python script
python un.py -s bash 'echo hello' Inline bash command
python un.py session --list List active sessions
python un.py service --list List all services
python un.py snapshot --list List all snapshots
python un.py key Check API key
python un.py languages List available languages
python un.py languages --json List languages as JSON
""",
)
# Global options
parser.add_argument("-s", "--shell", metavar="LANG",
help="Language for inline code execution")
parser.add_argument("-e", "--env", action="append", metavar="KEY=VAL",
help="Set environment variable (can be used multiple times)")
parser.add_argument("-f", "--file", action="append", metavar="FILE",
help="Add input file to /tmp/ (can be used multiple times)")
parser.add_argument("-F", "--file-path", action="append", metavar="FILE",
help="Add input file with path preserved")
parser.add_argument("-a", "--artifacts", action="store_true",
help="Return compiled artifacts")
parser.add_argument("-o", "--output", metavar="DIR",
help="Output directory for artifacts")
parser.add_argument("-p", "--public-key", metavar="KEY",
help="API public key")
parser.add_argument("-k", "--secret-key", metavar="KEY",
help="API secret key")
parser.add_argument("-n", "--network", choices=["zerotrust", "semitrusted"],
default="zerotrust", help="Network mode (default: zerotrust)")
parser.add_argument("-v", "--vcpu", type=int, default=1, choices=range(1, 9),
metavar="N", help="vCPU count (1-8, default: 1)")
parser.add_argument("-y", "--yes", action="store_true",
help="Skip confirmation prompts")
# Subcommands
subparsers = parser.add_subparsers(dest="command", help="Commands")
# Session subcommand
session_parser = subparsers.add_parser("session", help="Manage interactive sessions")
session_group = session_parser.add_mutually_exclusive_group()
session_group.add_argument("-l", "--list", action="store_true",
help="List active sessions")
session_group.add_argument("--attach", metavar="ID",
help="Reconnect to existing session")
session_group.add_argument("--kill", metavar="ID",
help="Terminate a session")
session_group.add_argument("--freeze", metavar="ID",
help="Pause session")
session_group.add_argument("--unfreeze", metavar="ID",
help="Resume session")
session_group.add_argument("--boost", metavar="ID",
help="Add resources to session")
session_group.add_argument("--unboost", metavar="ID",
help="Remove boost from session")
session_group.add_argument("--snapshot", metavar="ID",
help="Create snapshot of session")
session_parser.add_argument("--shell", metavar="SHELL",
help="Shell/REPL to use (default: bash)")
session_parser.add_argument("--tmux", action="store_true",
help="Enable persistence with tmux")
session_parser.add_argument("--screen", action="store_true",
help="Enable persistence with screen")
session_parser.add_argument("--snapshot-name", metavar="NAME",
help="Name for snapshot")
session_parser.add_argument("--hot", action="store_true",
help="Live snapshot (no freeze)")
session_parser.add_argument("--audit", action="store_true",
help="Record session")
# Service subcommand
service_parser = subparsers.add_parser("service", help="Manage persistent services")
service_group = service_parser.add_mutually_exclusive_group()
service_group.add_argument("-l", "--list", action="store_true",
help="List all services")
service_group.add_argument("--info", metavar="ID",
help="Get service details")
service_group.add_argument("--logs", metavar="ID",
help="Get all logs")
service_group.add_argument("--tail", metavar="ID",
help="Get last 9000 lines of logs")
service_group.add_argument("--freeze", metavar="ID",
help="Pause service")
service_group.add_argument("--unfreeze", metavar="ID",
help="Resume service")
service_group.add_argument("--destroy", metavar="ID",
help="Delete service")
service_group.add_argument("--lock", metavar="ID",
help="Prevent deletion")
service_group.add_argument("--unlock", metavar="ID",
help="Allow deletion")
service_group.add_argument("--add-domain", metavar="ID",
help="Add domains (with --domains)")
service_group.add_argument("--remove-domain", metavar="ID",
help="Remove domains (with --domains)")
service_group.add_argument("--set-domains", metavar="ID",
help="Replace all domains (with --domains)")
service_group.add_argument("--resize", metavar="ID",
help="Resize service (with --vcpu)")
service_group.add_argument("--redeploy", metavar="ID",
help="Re-run bootstrap")
service_group.add_argument("--execute", nargs=2, metavar=("ID", "CMD"),
help="Run command in service")
service_group.add_argument("--snapshot", metavar="ID",
help="Create snapshot of service")
service_parser.add_argument("--name", metavar="NAME",
help="Service name (creates new)")
service_parser.add_argument("--ports", metavar="PORTS",
help="Comma-separated ports")
service_parser.add_argument("--domains", metavar="DOMAINS",
help="Custom domains")
service_parser.add_argument("--type", metavar="TYPE", dest="service_type",
help="Service type (minecraft, tcp, udp)")
service_parser.add_argument("--bootstrap", metavar="CMD",
help="Bootstrap command")
service_parser.add_argument("--bootstrap-file", metavar="FILE",
help="Bootstrap from file")
service_parser.add_argument("--env-file", metavar="FILE",
help="Load env from .env file")
service_parser.add_argument("--snapshot-name", metavar="NAME",
help="Name for snapshot")
service_parser.add_argument("--hot", action="store_true",
help="Live snapshot (no freeze)")
service_parser.add_argument("--golden-image", metavar="IMAGE",
help="LXD image alias (e.g., golden-alpine-3.21)")
service_parser.add_argument("-f", "--file", action="append", dest="files",
metavar="FILE",
help="Input file to upload (written to /tmp/ in container)")
# Service env subcommand
service_env_parser = subparsers.add_parser("service-env",
help="Manage service environment vault")
service_env_parser.add_argument("action", choices=["status", "set", "export", "delete"],
help="Environment action")
service_env_parser.add_argument("service_id", metavar="ID",
help="Service ID")
service_env_parser.add_argument("--env-file", metavar="FILE",
help="Load env from .env file (for set)")
# Snapshot subcommand
snapshot_parser = subparsers.add_parser("snapshot", help="Manage snapshots")
snapshot_group = snapshot_parser.add_mutually_exclusive_group()
snapshot_group.add_argument("-l", "--list", action="store_true",
help="List all snapshots")
snapshot_group.add_argument("--info", metavar="ID",
help="Get snapshot details")
snapshot_group.add_argument("--delete", metavar="ID",
help="Delete snapshot")
snapshot_group.add_argument("--lock", metavar="ID",
help="Prevent deletion")
snapshot_group.add_argument("--unlock", metavar="ID",
help="Allow deletion")
snapshot_group.add_argument("--clone", metavar="ID",
help="Clone snapshot")
snapshot_parser.add_argument("--type", choices=["session", "service"],
dest="clone_type", help="Clone type")
snapshot_parser.add_argument("--name", metavar="NAME",
help="Name for cloned resource")
snapshot_parser.add_argument("--shell", metavar="SHELL",
help="Shell for cloned session")
snapshot_parser.add_argument("--ports", metavar="PORTS",
help="Ports for cloned service")
# Image subcommand
image_parser = subparsers.add_parser("image", help="Manage images")
image_group = image_parser.add_mutually_exclusive_group()
image_group.add_argument("-l", "--list", action="store_true",
help="List all images")
image_group.add_argument("--info", metavar="ID",
help="Get image details")
image_group.add_argument("--delete", metavar="ID",
help="Delete image")
image_group.add_argument("--lock", metavar="ID",
help="Prevent deletion")
image_group.add_argument("--unlock", metavar="ID",
help="Allow deletion")
image_group.add_argument("--publish", metavar="ID",
help="Publish image from service/snapshot (requires --source-type)")
image_group.add_argument("--visibility", nargs=2, metavar=("ID", "MODE"),
help="Set visibility (private, unlisted, public)")
image_group.add_argument("--spawn", metavar="ID",
help="Spawn new service from image")
image_group.add_argument("--clone", metavar="ID",
help="Clone an image")
image_parser.add_argument("--source-type", metavar="TYPE",
choices=["service", "snapshot"],
help="Source type for publish (service or snapshot)")
image_parser.add_argument("--name", metavar="NAME",
help="Name for spawned service or cloned image")
image_parser.add_argument("--ports", metavar="PORTS",
help="Ports for spawned service (comma-separated)")
# Key subcommand
subparsers.add_parser("key", help="Check API key validity")
# Languages subcommand
languages_parser = subparsers.add_parser("languages", help="List available languages")
languages_parser.add_argument("--json", action="store_true",
help="Output as JSON array")
# Positional argument for source file or inline code
parser.add_argument("source", nargs="?",
help="Source file or inline code (with -s)")
return parser
def cli_main():
"""Main entry point for CLI."""
parser = _build_parser()
args = parser.parse_args()
# Resolve credentials
try:
public_key, secret_key = _resolve_credentials(
args.public_key, args.secret_key
)
except CredentialsError as e:
print(f"Error: {e}", file=sys.stderr)
sys.exit(3)
try:
# Handle subcommands
if args.command == "session":
_handle_session_command(args, public_key, secret_key)
elif args.command == "service":
_handle_service_command(args, public_key, secret_key)
elif args.command == "service-env":
_handle_service_env_command(args, public_key, secret_key)
elif args.command == "snapshot":
_handle_snapshot_command(args, public_key, secret_key)
elif args.command == "image":
_handle_image_command(args, public_key, secret_key)
elif args.command == "key":
_handle_key_command(public_key, secret_key)
elif args.command == "languages":
_handle_languages_command(args, public_key, secret_key)
elif args.source or args.shell:
_handle_execute_command(args, public_key, secret_key)
else:
parser.print_help()
sys.exit(2)
except CredentialsError as e:
print(f"Error: {e}", file=sys.stderr)
sys.exit(3)
except requests.exceptions.HTTPError as e:
if e.response is not None and e.response.status_code == 401:
print("Error: Authentication failed", file=sys.stderr)
sys.exit(3)
print(f"Error: API error - {e}", file=sys.stderr)
sys.exit(4)
except requests.exceptions.RequestException as e:
print(f"Error: Network error - {e}", file=sys.stderr)
sys.exit(1)
except Exception as e:
print(f"Error: {e}", file=sys.stderr)
sys.exit(1)
def _handle_execute_command(args, public_key: str, secret_key: str):
"""Handle code execution command."""
# Determine language and code
if args.shell:
# Inline code mode
if not args.source:
print("Error: Code required with -s/--shell", file=sys.stderr)
sys.exit(2)
language = args.shell
code = args.source
else:
# File mode
if not args.source:
print("Error: Source file required", file=sys.stderr)
sys.exit(2)
# Detect language from filename
language = detect_language(args.source)
if not language:
print(f"Error: Cannot detect language from '{args.source}'", file=sys.stderr)
sys.exit(2)
# Read source file
try:
with open(args.source, "r") as f:
code = f.read()
except FileNotFoundError:
print(f"Error: File not found: {args.source}", file=sys.stderr)
sys.exit(1)
except Exception as e:
print(f"Error: Failed to read file: {e}", file=sys.stderr)
sys.exit(1)
# Execute code
result = execute_code(language, code, public_key, secret_key)
# Output result
stdout = result.get("stdout", "")
stderr = result.get("stderr", "")
exit_code = result.get("exit_code", 0)
execution_time = result.get("execution_time_ms", 0)
if stdout:
print(stdout, end="")
if not stdout.endswith("\n"):
print()
if stderr:
print(stderr, end="", file=sys.stderr)
if not stderr.endswith("\n"):
print(file=sys.stderr)
print("---")
print(f"Exit code: {exit_code}")
print(f"Execution time: {execution_time}ms")
sys.exit(exit_code if exit_code else 0)
def _handle_session_command(args, public_key: str, secret_key: str):
"""Handle session subcommand."""
if args.list:
sessions = list_sessions(public_key, secret_key)
print(_format_list_output(sessions, "session"))
elif args.attach:
# Get session info for attach
session = get_session(args.attach, public_key, secret_key)
print(f"Session ID: {session.get('id', session.get('session_id', ''))}")
print(f"Status: {session.get('status', 'unknown')}")
print(f"WebSocket URL: wss://api.unsandbox.com/sessions/{args.attach}/shell")
print("\nUse a WebSocket client to connect interactively.")
elif args.kill:
result = delete_session(args.kill, public_key, secret_key)
print(f"Session {args.kill} terminated")
elif args.freeze:
result = freeze_session(args.freeze, public_key, secret_key)
print(f"Session {args.freeze} frozen")
elif args.unfreeze:
result = unfreeze_session(args.unfreeze, public_key, secret_key)
print(f"Session {args.unfreeze} unfrozen")
elif args.boost:
result = boost_session(args.boost, public_key, secret_key)
print(f"Session {args.boost} boosted")
elif args.unboost:
result = unboost_session(args.unboost, public_key, secret_key)
print(f"Session {args.unboost} unboosted")
elif args.snapshot:
snapshot_id = session_snapshot(
args.snapshot, public_key, secret_key,
name=args.snapshot_name,
ephemeral=not args.hot
)
print(f"Snapshot created: {snapshot_id}")
else:
# Create new session
multiplexer = None
if args.tmux:
multiplexer = "tmux"
elif args.screen:
multiplexer = "screen"
result = create_session(
shell=args.shell,
network_mode="semitrusted" if hasattr(args, 'network') and args.network == "semitrusted" else "zerotrust",
public_key=public_key,
secret_key=secret_key,
multiplexer=multiplexer,
)
session_id = result.get("session_id", result.get("id", ""))
print(f"Session created: {session_id}")
print(f"WebSocket URL: wss://api.unsandbox.com/sessions/{session_id}/shell")
def _handle_service_command(args, public_key: str, secret_key: str):
"""Handle service subcommand."""
if args.list:
services = list_services(public_key, secret_key)
print(_format_list_output(services, "service"))
elif args.info:
service = get_service(args.info, public_key, secret_key)
print(json.dumps(service, indent=2))
elif args.logs:
result = get_service_logs(args.logs, all_logs=True, public_key=public_key, secret_key=secret_key)
print(result.get("log", ""))
elif args.tail:
result = get_service_logs(args.tail, all_logs=False, public_key=public_key, secret_key=secret_key)
print(result.get("log", ""))
elif args.freeze:
result = freeze_service(args.freeze, public_key, secret_key)
print(f"Service {args.freeze} frozen")
elif args.unfreeze:
result = unfreeze_service(args.unfreeze, public_key, secret_key)
print(f"Service {args.unfreeze} unfrozen")
elif args.destroy:
result = delete_service(args.destroy, public_key, secret_key)
print(f"Service {args.destroy} destroyed")
elif args.lock:
result = lock_service(args.lock, public_key, secret_key)
print(f"Service {args.lock} locked")
elif args.unlock:
result = unlock_service(args.unlock, public_key, secret_key)
print(f"Service {args.unlock} unlocked")
elif getattr(args, 'add_domain', None):
if not args.domains:
print("Error: --domains required with --add-domain", file=sys.stderr)
sys.exit(2)
domains = [d.strip() for d in args.domains.split(",")]
result = update_service_domains(args.add_domain, domains, "add", public_key, secret_key)
print(f"Domains added to {args.add_domain}")
print(f"Domains: {result.get('custom_domains', [])}")
elif getattr(args, 'remove_domain', None):
if not args.domains:
print("Error: --domains required with --remove-domain", file=sys.stderr)
sys.exit(2)
domains = [d.strip() for d in args.domains.split(",")]
result = update_service_domains(args.remove_domain, domains, "remove", public_key, secret_key)
print(f"Domains removed from {args.remove_domain}")
print(f"Domains: {result.get('custom_domains', [])}")
elif getattr(args, 'set_domains', None):
if not args.domains:
print("Error: --domains required with --set-domains", file=sys.stderr)
sys.exit(2)
domains = [d.strip() for d in args.domains.split(",")]
result = update_service_domains(args.set_domains, domains, "custom_domains", public_key, secret_key)
print(f"Domains set for {args.set_domains}")
print(f"Domains: {result.get('custom_domains', [])}")
elif args.resize:
vcpu = getattr(args, 'vcpu', 1) or 1
result = update_service(args.resize, public_key, secret_key, vcpu=vcpu)
print(f"Service {args.resize} resized to {vcpu} vCPU(s)")
elif args.redeploy:
bootstrap = None
if args.bootstrap_file:
with open(args.bootstrap_file, "r") as f:
bootstrap = f.read()
elif args.bootstrap:
bootstrap = args.bootstrap
result = redeploy_service(args.redeploy, bootstrap=bootstrap, public_key=public_key, secret_key=secret_key)
print(f"Service {args.redeploy} redeployed")
elif args.execute:
service_id, command = args.execute
result = execute_in_service(service_id, command, public_key=public_key, secret_key=secret_key)
# Handle async result
if result.get("job_id"):
job_result = wait_for_job(result["job_id"], public_key, secret_key)
stdout = job_result.get("stdout", "")
stderr = job_result.get("stderr", "")
if stdout:
print(stdout, end="")
if stderr:
print(stderr, end="", file=sys.stderr)
else:
stdout = result.get("stdout", "")
stderr = result.get("stderr", "")
if stdout:
print(stdout, end="")
if stderr:
print(stderr, end="", file=sys.stderr)
elif args.snapshot:
snapshot_id = service_snapshot(
args.snapshot, public_key, secret_key,
name=getattr(args, 'snapshot_name', None)
)
print(f"Snapshot created: {snapshot_id}")
elif args.name:
# Create new service
if not args.ports:
print("Error: --ports required when creating service", file=sys.stderr)
sys.exit(2)
ports = [int(p.strip()) for p in args.ports.split(",")]
bootstrap = None
if args.bootstrap_file:
with open(args.bootstrap_file, "r") as f:
bootstrap = f.read()
elif args.bootstrap:
bootstrap = args.bootstrap
custom_domains = None
if args.domains:
custom_domains = [d.strip() for d in args.domains.split(",")]
# Build input_files from -f args
service_input_files = None
if getattr(args, 'files', None):
import base64 as _b64
service_input_files = []
for fpath in args.files:
with open(fpath, "rb") as ff:
encoded = _b64.b64encode(ff.read()).decode("ascii")
service_input_files.append({
"filename": os.path.basename(fpath),
"content": encoded,
})
result = create_service(
name=args.name,
ports=ports,
bootstrap=bootstrap,
public_key=public_key,
secret_key=secret_key,
custom_domains=custom_domains,
vcpu=getattr(args, 'vcpu', 1) or 1,
service_type=args.service_type,
golden_image=getattr(args, 'golden_image', None),
input_files=service_input_files,
)
service_id = result.get("service_id", result.get("id", ""))
print(f"Service created: {service_id}")
print(f"URL: https://{args.name}.on.unsandbox.com")
else:
print("Error: No action specified for service command", file=sys.stderr)
sys.exit(2)
def _handle_service_env_command(args, public_key: str, secret_key: str):
"""Handle service env subcommand."""
if args.action == "status":
result = get_service_env(args.service_id, public_key, secret_key)
print(f"Has vault: {result.get('has_vault', False)}")
print(f"Variable count: {result.get('count', 0)}")
if result.get('updated_at'):
print(f"Updated at: {result.get('updated_at')}")
elif args.action == "set":
# Read env from file or stdin
if args.env_file:
env_dict = _parse_env_file(args.env_file)
else:
# Read from stdin
print("Enter environment variables (KEY=VALUE), one per line. Ctrl+D to finish:", file=sys.stderr)
env_dict = {}
for line in sys.stdin:
line = line.strip()
if line and "=" in line:
key, _, value = line.partition("=")
env_dict[key.strip()] = value.strip()
result = set_service_env(args.service_id, env_dict, public_key, secret_key)
print(f"Environment set: {result.get('count', len(env_dict))} variables")
elif args.action == "export":
result = export_service_env(args.service_id, public_key, secret_key)
env_content = result.get("env", "")
print(env_content)
elif args.action == "delete":
result = delete_service_env(args.service_id, public_key=public_key, secret_key=secret_key)
print(f"Environment vault deleted for service {args.service_id}")
def _handle_snapshot_command(args, public_key: str, secret_key: str):
"""Handle snapshot subcommand."""
if args.list:
snapshots = list_snapshots(public_key, secret_key)
print(_format_list_output(snapshots, "snapshot"))
elif args.info:
# Get snapshot info via listing and filtering
snapshots = list_snapshots(public_key, secret_key)
snapshot = next((s for s in snapshots if s.get("id") == args.info or s.get("snapshot_id") == args.info), None)
if snapshot:
print(json.dumps(snapshot, indent=2))
else:
print(f"Error: Snapshot {args.info} not found", file=sys.stderr)
sys.exit(1)
elif args.delete:
result = delete_snapshot(args.delete, public_key, secret_key)
print(f"Snapshot {args.delete} deleted")
elif args.lock:
result = lock_snapshot(args.lock, public_key, secret_key)
print(f"Snapshot {args.lock} locked")
elif args.unlock:
result = unlock_snapshot(args.unlock, public_key, secret_key)
print(f"Snapshot {args.unlock} unlocked")
elif args.clone:
clone_type = args.clone_type or "session"
ports = None
if args.ports:
ports = [int(p.strip()) for p in args.ports.split(",")]
result = clone_snapshot(
args.clone,
clone_type=clone_type,
name=args.name,
public_key=public_key,
secret_key=secret_key,
shell=args.shell,
ports=ports,
)
if clone_type == "session":
print(f"Session created: {result.get('session_id', result.get('id', ''))}")
else:
print(f"Service created: {result.get('service_id', result.get('id', ''))}")
else:
print("Error: No action specified for snapshot command", file=sys.stderr)
sys.exit(2)
def _handle_image_command(args, public_key: str, secret_key: str):
"""Handle image subcommand."""
if args.list:
images = list_images(public_key=public_key, secret_key=secret_key)
print(_format_list_output(images, "image"))
elif args.info:
image = get_image(args.info, public_key=public_key, secret_key=secret_key)
print(json.dumps(image, indent=2))
elif args.delete:
result = delete_image(args.delete, public_key=public_key, secret_key=secret_key)
print(f"Image {args.delete} deleted")
elif args.lock:
result = lock_image(args.lock, public_key=public_key, secret_key=secret_key)
print(f"Image {args.lock} locked")
elif args.unlock:
result = unlock_image(args.unlock, public_key=public_key, secret_key=secret_key)
print(f"Image {args.unlock} unlocked")
elif args.publish:
if not args.source_type:
print("Error: --source-type required for --publish", file=sys.stderr)
sys.exit(2)
result = image_publish(
source_type=args.source_type,
source_id=args.publish,
name=args.name,
public_key=public_key,
secret_key=secret_key,
)
image_id = result.get("image_id", result.get("id", ""))
print(f"Image published: {image_id}")
elif args.visibility:
image_id, mode = args.visibility
if mode not in ("private", "unlisted", "public"):
print(f"Error: Invalid visibility mode '{mode}'. Must be private, unlisted, or public", file=sys.stderr)
sys.exit(2)
result = set_image_visibility(image_id, mode, public_key=public_key, secret_key=secret_key)
print(f"Image {image_id} visibility set to {mode}")
elif args.spawn:
if not args.name:
print("Error: --name required for --spawn", file=sys.stderr)
sys.exit(2)
ports = None
if args.ports:
ports = [int(p.strip()) for p in args.ports.split(",")]
result = spawn_from_image(
args.spawn,
name=args.name,
ports=ports,
public_key=public_key,
secret_key=secret_key,
)
service_id = result.get("service_id", result.get("id", ""))
print(f"Service spawned: {service_id}")
elif args.clone:
result = clone_image(
args.clone,
name=args.name,
public_key=public_key,
secret_key=secret_key,
)
image_id = result.get("image_id", result.get("id", ""))
print(f"Image cloned: {image_id}")
else:
print("Error: No action specified for image command", file=sys.stderr)
sys.exit(2)
def _handle_key_command(public_key: str, secret_key: str):
"""Handle key validation command."""
result = validate_keys(public_key, secret_key)
print(f"Public key: {public_key}")
print(f"Valid: {result.get('valid', False)}")
if result.get('tier'):
print(f"Tier: {result.get('tier')}")
if result.get('expires_at'):
print(f"Expires: {result.get('expires_at')}")
if result.get('reason'):
print(f"Reason: {result.get('reason')}")
def _handle_languages_command(args, public_key: str, secret_key: str):
"""Handle languages list command."""
languages = get_languages(public_key, secret_key)
if args.json:
# Output as JSON array
print(json.dumps(languages))
else:
# Output one language per line (pipe-friendly)
for lang in languages:
print(lang)
if __name__ == "__main__":
cli_main()
Documentation clarifications
Dependencies
C Binary (un1) — requires libcurl and libwebsockets:
sudo apt install build-essential libcurl4-openssl-dev libwebsockets-dev
wget unsandbox.com/downloads/un.c && gcc -O2 -o un un.c -lcurl -lwebsockets
SDK Implementations — most use stdlib only (Ruby, JS, Go, etc). Some require minimal deps:
pip install requests # Python
Execute Code
Run a Script
./un hello.py
./un app.js
./un main.rs
With Environment Variables
./un -e DEBUG=1 -e NAME=World script.py
With Input Files (teleport files into sandbox)
./un -f data.csv -f config.json process.py
Get Compiled Binary (teleport artifacts out)
./un -a -o ./bin main.c
Interactive Sessions
Start a Shell Session
# Default bash shell
./un session
# Choose your shell
./un session --shell zsh
./un session --shell fish
# Jump into a REPL
./un session --shell python3
./un session --shell node
./un session --shell julia
Session with Network Access
./un session -n semitrusted
Session Auditing (full terminal recording)
# Record everything (including vim, interactive programs)
./un session --audit -o ./logs
# Replay session later
zcat session.log*.gz | less -R
Collect Artifacts from Session
# Files in /tmp/artifacts/ are collected on exit
./un session -a -o ./outputs
Session Persistence (tmux/screen)
# Default: session terminates on disconnect (clean exit)
./un session
# With tmux: session persists, can reconnect later
./un session --tmux
# Press Ctrl+b then d to detach
# With screen: alternative multiplexer
./un session --screen
# Press Ctrl+a then d to detach
List Active Sessions
./un session --list
# Output:
# Active sessions: 2
#
# SESSION ID CONTAINER SHELL TTL STATUS
# abc123... unsb-vm-12345 python3 45m30s active
# def456... unsb-vm-67890 bash 1h2m active
Reconnect to Existing Session
# Reconnect by container name (requires --tmux or --screen)
./un session --attach unsb-vm-12345
# Use exit to terminate session, or detach to keep it running
Terminate a Session
./un session --kill unsb-vm-12345
Available Shells & REPLs
Shells: bash, dash, sh, zsh, fish, ksh, tcsh, csh, elvish, xonsh, ash
REPLs: python3, bpython, ipython # Python
node # JavaScript
ruby, irb # Ruby
lua # Lua
php # PHP
perl # Perl
guile, scheme # Scheme
ghci # Haskell
erl, iex # Erlang/Elixir
sbcl, clisp # Common Lisp
r # R
julia # Julia
clojure # Clojure
API Key Management
Check Key Status
# Check if your API key is valid
./un key
# Output:
# Valid: key expires in 30 days
Extend Expired Key
# Open the portal to extend an expired key
./un key --extend
# This opens the unsandbox.com portal where you can
# add more credits to extend your key's expiration
Authentication
Credentials are loaded in priority order (highest first):
# 1. CLI flags (highest priority)
./un -p unsb-pk-xxxx -k unsb-sk-xxxxx script.py
# 2. Environment variables
export UNSANDBOX_PUBLIC_KEY=unsb-pk-xxxx-xxxx-xxxx-xxxx
export UNSANDBOX_SECRET_KEY=unsb-sk-xxxxx-xxxxx-xxxxx-xxxxx
./un script.py
# 3. Config file (lowest priority)
# ~/.unsandbox/accounts.csv format: public_key,secret_key
mkdir -p ~/.unsandbox
echo "unsb-pk-xxxx-xxxx-xxxx-xxxx,unsb-sk-xxxxx-xxxxx-xxxxx-xxxxx" > ~/.unsandbox/accounts.csv
./un script.py
Requests are signed with HMAC-SHA256. The bearer token contains only the public key; the secret key computes the signature (never transmitted).
Resource Scaling
Set vCPU Count
# Default: 1 vCPU, 2GB RAM
./un script.py
# Scale up: 4 vCPUs, 8GB RAM
./un -v 4 script.py
# Maximum: 8 vCPUs, 16GB RAM
./un --vcpu 8 heavy_compute.py
Live Session Boosting
# Boost a running session to 2 vCPU, 4GB RAM
./un session --boost sandbox-abc
# Boost to specific vCPU count (4 vCPU, 8GB RAM)
./un session --boost sandbox-abc --boost-vcpu 4
# Return to base resources (1 vCPU, 2GB RAM)
./un session --unboost sandbox-abc
Session Freeze/Unfreeze
Freeze and Unfreeze Sessions
# Freeze a session (stop billing, preserve state)
./un session --freeze sandbox-abc
# Unfreeze a frozen session
./un session --unfreeze sandbox-abc
# Note: Requires --tmux or --screen for persistence
Persistent Services
Create a Service
# Web server with ports
./un service --name web --ports 80,443 --bootstrap "python -m http.server 80"
# With custom domains
./un service --name blog --ports 8000 --domains blog.example.com
# Game server with SRV records
./un service --name mc --type minecraft --bootstrap ./setup.sh
# Deploy app tarball with bootstrap script
./un service --name app --ports 8000 -f app.tar.gz --bootstrap-file ./setup.sh
# setup.sh: cd /tmp && tar xzf app.tar.gz && ./app/start.sh
Manage Services
# List all services
./un service --list
# Get service details
./un service --info abc123
# View bootstrap logs
./un service --logs abc123
./un service --tail abc123 # last 9000 lines
# Execute command in running service
./un service --execute abc123 'journalctl -u myapp -n 50'
# Dump bootstrap script (for migrations)
./un service --dump-bootstrap abc123
./un service --dump-bootstrap abc123 backup.sh
# Freeze/unfreeze service
./un service --freeze abc123
./un service --unfreeze abc123
# Service settings (auto-wake, freeze page display)
./un service --auto-unfreeze abc123 # enable auto-wake on HTTP
./un service --no-auto-unfreeze abc123 # disable auto-wake
./un service --show-freeze-page abc123 # show HTML payment page (default)
./un service --no-show-freeze-page abc123 # return JSON error instead
# Redeploy with new bootstrap
./un service --redeploy abc123 --bootstrap ./new-setup.sh
# Destroy service
./un service --destroy abc123
Snapshots
List Snapshots
./un snapshot --list
# Output:
# Snapshots: 3
#
# SNAPSHOT ID NAME SOURCE SIZE CREATED
# unsb-snapshot-a1b2-c3d4-e5f6-g7h8 before-upgrade session 512 MB 2h ago
# unsb-snapshot-i9j0-k1l2-m3n4-o5p6 stable-v1.0 service 1.2 GB 1d ago
Create Session Snapshot
# Snapshot with name
./un session --snapshot unsb-vm-12345 --name "before upgrade"
# Quick snapshot (auto-generated name)
./un session --snapshot unsb-vm-12345
Create Service Snapshot
# Standard snapshot (pauses container briefly)
./un service --snapshot unsb-service-abc123 --name "stable v1.0"
# Hot snapshot (no pause, may be inconsistent)
./un service --snapshot unsb-service-abc123 --hot
Restore from Snapshot
# Restore session from snapshot
./un session --restore unsb-snapshot-a1b2-c3d4-e5f6-g7h8
# Restore service from snapshot
./un service --restore unsb-snapshot-i9j0-k1l2-m3n4-o5p6
Delete Snapshot
./un snapshot --delete unsb-snapshot-a1b2-c3d4-e5f6-g7h8
Images
Images are independent, transferable container images that survive container deletion. Unlike snapshots (which live with their container), images can be shared with other users, transferred between API keys, or made public in the marketplace.
List Images
# List all images (owned + shared + public)
./un image --list
# List only your images
./un image --list owned
# List images shared with you
./un image --list shared
# List public marketplace images
./un image --list public
# Get image details
./un image --info unsb-image-xxxx-xxxx-xxxx-xxxx
Publish Images
# Publish from a stopped or frozen service
./un image --publish-service unsb-service-abc123 \
--name "My App v1.0" --description "Production snapshot"
# Publish from a snapshot
./un image --publish-snapshot unsb-snapshot-xxxx-xxxx-xxxx-xxxx \
--name "Stable Release"
# Note: Cannot publish from running containers - stop or freeze first
Create Services from Images
# Spawn a new service from an image
./un image --spawn unsb-image-xxxx-xxxx-xxxx-xxxx \
--name new-service --ports 80,443
# Clone an image (creates a copy you own)
./un image --clone unsb-image-xxxx-xxxx-xxxx-xxxx
Image Protection
# Lock image to prevent accidental deletion
./un image --lock unsb-image-xxxx-xxxx-xxxx-xxxx
# Unlock image to allow deletion
./un image --unlock unsb-image-xxxx-xxxx-xxxx-xxxx
# Delete image (must be unlocked)
./un image --delete unsb-image-xxxx-xxxx-xxxx-xxxx
Visibility & Sharing
# Set visibility level
./un image --visibility unsb-image-xxxx-xxxx-xxxx-xxxx private # owner only (default)
./un image --visibility unsb-image-xxxx-xxxx-xxxx-xxxx unlisted # can be shared
./un image --visibility unsb-image-xxxx-xxxx-xxxx-xxxx public # marketplace
# Share with specific user
./un image --grant unsb-image-xxxx-xxxx-xxxx-xxxx \
--key unsb-pk-friend-friend-friend-friend
# Revoke access
./un image --revoke unsb-image-xxxx-xxxx-xxxx-xxxx \
--key unsb-pk-friend-friend-friend-friend
# List who has access
./un image --trusted unsb-image-xxxx-xxxx-xxxx-xxxx
Transfer Ownership
# Transfer image to another API key
./un image --transfer unsb-image-xxxx-xxxx-xxxx-xxxx \
--to unsb-pk-newowner-newowner-newowner-newowner
Usage Reference
Usage: ./un [options] <source_file>
./un session [options]
./un service [options]
./un snapshot [options]
./un image [options]
./un key
Commands:
(default) Execute source file in sandbox
session Open interactive shell/REPL session
service Manage persistent services
snapshot Manage container snapshots
image Manage container images (publish, share, transfer)
key Check API key validity and expiration
Options:
-e KEY=VALUE Set environment variable (can use multiple times)
-f FILE Add input file (can use multiple times)
-a Return and save artifacts from /tmp/artifacts/
-o DIR Output directory for artifacts (default: current dir)
-p KEY Public key (or set UNSANDBOX_PUBLIC_KEY env var)
-k KEY Secret key (or set UNSANDBOX_SECRET_KEY env var)
-n MODE Network mode: zerotrust (default) or semitrusted
-v N, --vcpu N vCPU count 1-8, each vCPU gets 2GB RAM (default: 1)
-y Skip confirmation for large uploads (>1GB)
-h Show this help
Authentication (priority order):
1. -p and -k flags (public and secret key)
2. UNSANDBOX_PUBLIC_KEY + UNSANDBOX_SECRET_KEY env vars
3. ~/.unsandbox/accounts.csv (format: public_key,secret_key per line)
Session options:
-s, --shell SHELL Shell/REPL to use (default: bash)
-l, --list List active sessions
--attach ID Reconnect to existing session (ID or container name)
--kill ID Terminate a session (ID or container name)
--freeze ID Freeze a session (requires --tmux/--screen)
--unfreeze ID Unfreeze a frozen session
--boost ID Boost session resources (2 vCPU, 4GB RAM)
--boost-vcpu N Specify vCPU count for boost (1-8)
--unboost ID Return to base resources
--audit Record full session for auditing
--tmux Enable session persistence with tmux (allows reconnect)
--screen Enable session persistence with screen (allows reconnect)
Service options:
--name NAME Service name (creates new service)
--ports PORTS Comma-separated ports (e.g., 80,443)
--domains DOMAINS Custom domains (e.g., example.com,www.example.com)
--type TYPE Service type: minecraft, mumble, teamspeak, source, tcp, udp
--bootstrap CMD Bootstrap command/file/URL to run on startup
-f FILE Upload file to /tmp/ (can use multiple times)
-l, --list List all services
--info ID Get service details
--tail ID Get last 9000 lines of bootstrap logs
--logs ID Get all bootstrap logs
--freeze ID Freeze a service
--unfreeze ID Unfreeze a service
--auto-unfreeze ID Enable auto-wake on HTTP request
--no-auto-unfreeze ID Disable auto-wake on HTTP request
--show-freeze-page ID Show HTML payment page when frozen (default)
--no-show-freeze-page ID Return JSON error when frozen
--destroy ID Destroy a service
--redeploy ID Re-run bootstrap script (requires --bootstrap)
--execute ID CMD Run a command in a running service
--dump-bootstrap ID [FILE] Dump bootstrap script (for migrations)
--snapshot ID Create snapshot of session or service
--snapshot-name User-friendly name for snapshot
--hot Create snapshot without pausing (may be inconsistent)
--restore ID Restore session/service from snapshot ID
Snapshot options:
-l, --list List all snapshots
--info ID Get snapshot details
--delete ID Delete a snapshot permanently
Image options:
-l, --list [owned|shared|public] List images (all, owned, shared, or public)
--info ID Get image details
--publish-service ID Publish image from stopped/frozen service
--publish-snapshot ID Publish image from snapshot
--name NAME Name for published image
--description DESC Description for published image
--delete ID Delete image (must be unlocked)
--clone ID Clone image (creates copy you own)
--spawn ID Create service from image (requires --name)
--lock ID Lock image to prevent deletion
--unlock ID Unlock image to allow deletion
--visibility ID LEVEL Set visibility (private|unlisted|public)
--grant ID --key KEY Grant access to another API key
--revoke ID --key KEY Revoke access from API key
--transfer ID --to KEY Transfer ownership to API key
--trusted ID List API keys with access
Key options:
(no options) Check API key validity
--extend Open portal to extend an expired key
Examples:
./un script.py # execute Python script
./un -e DEBUG=1 script.py # with environment variable
./un -f data.csv process.py # with input file
./un -a -o ./bin main.c # save compiled artifacts
./un -v 4 heavy.py # with 4 vCPUs, 8GB RAM
./un session # interactive bash session
./un session --tmux # bash with reconnect support
./un session --list # list active sessions
./un session --attach unsb-vm-12345 # reconnect to session
./un session --kill unsb-vm-12345 # terminate a session
./un session --freeze unsb-vm-12345 # freeze session
./un session --unfreeze unsb-vm-12345 # unfreeze session
./un session --boost unsb-vm-12345 # boost resources
./un session --unboost unsb-vm-12345 # return to base
./un session --shell python3 # Python REPL
./un session --shell node # Node.js REPL
./un session -n semitrusted # session with network access
./un session --audit -o ./logs # record session for auditing
./un service --name web --ports 80 # create web service
./un service --list # list all services
./un service --logs abc123 # view bootstrap logs
./un key # check API key
./un key --extend # extend expired key
./un snapshot --list # list all snapshots
./un session --snapshot unsb-vm-123 # snapshot a session
./un service --snapshot abc123 # snapshot a service
./un session --restore unsb-snapshot-xxxx # restore from snapshot
./un image --list # list all images
./un image --list owned # list your images
./un image --publish-service abc # publish image from service
./un image --spawn img123 --name x # create service from image
./un image --grant img --key pk # share image with user
CLI Inception
The UN CLI has been implemented in 42 programming languages, demonstrating that the unsandbox API can be accessed from virtually any environment.
License
PUBLIC DOMAIN - NO LICENSE, NO WARRANTY
This is free public domain software for the public good of a permacomputer hosted
at permacomputer.com - an always-on computer by the people, for the people. One
that is durable, easy to repair, and distributed like tap water for machine
learning intelligence.
The permacomputer is community-owned infrastructure optimized around four values:
TRUTH - First principles, math & science, open source code freely distributed
FREEDOM - Voluntary partnerships, freedom from tyranny & corporate control
HARMONY - Minimal waste, self-renewing systems with diverse thriving connections
LOVE - Be yourself without hurting others, cooperation through natural law
This software contributes to that vision by enabling code execution across all 42
programming languages through a unified interface, accessible to everyone. Code is
seeds to sprout on any abandoned technology.
Learn more: https://www.permacomputer.com
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
software, either in source code form or as a compiled binary, for any purpose,
commercial or non-commercial, and by any means.
NO WARRANTY. THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
That said, our permacomputer's digital membrane stratum continuously runs unit,
integration, and functional tests on all its own software - with our permacomputer
monitoring itself, repairing itself, with minimal human guidance in the loop.
Our agents do their best.
Copyright 2025 TimeHexOn & foxhop & russell@unturf
https://www.timehexon.com
https://www.foxhop.net
https://www.unturf.com/software