Skip to main content
Definitions of key terms used in Hopx Sandboxes documentation.

A

API Key: A unique identifier used to authenticate API requests. Get your API key from the dashboard. Agent API: The API for interacting with running sandboxes (code execution, file operations, commands, etc.).

B

Hopx Sandbox: A secure, isolated cloud virtual machine (microVM) that provides a safe environment for running untrusted code.

C

Code Execution: Running code (Python, JavaScript, etc.) inside a sandbox. Cold Start: The time it takes to create and start a new sandbox from scratch (~100ms).

D

Dashboard: The web interface for managing sandboxes, viewing metrics, and configuring settings. Available at console.hopx.dev.

E

Environment Variables: Variables passed to sandboxes for configuration and secrets management.

F

Filesystem: The isolated file system within each sandbox. Each sandbox has its own completely separate filesystem.

I

Isolation: Complete separation between sandboxes. Each sandbox runs in its own VM with separate filesystem, network, and processes.

L

Lifecycle API: The API for managing sandbox lifecycle (create, start, stop, pause, resume, delete).

M

MicroVM: A lightweight virtual machine optimized for fast startup and resource efficiency.

N

Network Namespace: The isolated network stack for each sandbox. Each sandbox has its own IP address and network configuration.

P

Pause: Temporarily suspend a sandbox while preserving its state. Paused sandboxes cost less than running sandboxes. Process Tree: The isolated process namespace for each sandbox. Processes in one sandbox cannot access processes in another.

R

Region: A geographic location where sandboxes can be created. Choose the closest region for best performance. Resume: Restart a paused sandbox, restoring its previous state. Rich Outputs: Automatically captured outputs from code execution, including plots, images, and DataFrames.

S

Sandbox: See Hopx Sandbox. SDK: Software Development Kit. Hopx provides SDKs for Python, JavaScript, Go, .NET, Java, and PHP.

T

Template: A pre-configured VM image with specific packages and configurations. Templates reduce setup time. Timeout: The maximum time allowed for an operation to complete before it’s cancelled.

V

VM: Virtual Machine. Each sandbox runs in its own isolated VM. vCPU: Virtual CPU. The number of virtual CPUs allocated to a sandbox.

W

WebSocket: A protocol for real-time, bidirectional communication. Used for streaming code execution output. Workspace: The default working directory (/workspace) in each sandbox where files are typically stored.

Next Steps