Environment Variables

Manage environment variables in HopX sandboxes to configure execution environments. This hub covers all environment variable operations, from basic get/set to advanced bulk updates.

​

Related

• CLI Environment Variables - Environment variables from CLI

​

What You’ll Learn

• How to get and set environment variables
• How to update existing variables
• How to clear all environment variables
• How to use environment variables in code execution
• How to manage variables across sandbox sessions

​

Environment Variables Overview

​

Core Concepts

​

Getting Environment Variables

Retrieve environment variables from sandboxes.

• Getting Environment Variables - Get environment variables
• SDK: Python: sandbox.env.get() | Python: sandbox.env.get_all() | JavaScript: sandbox.env.get() | JavaScript: sandbox.env.getAll()
• API: GET /env

​

Setting Environment Variables

Set environment variables in sandboxes.

• Setting Environment Variables - Set environment variables
• SDK: Python: sandbox.env.set() | Python: sandbox.env.set_all() | JavaScript: sandbox.env.set() | JavaScript: sandbox.env.setAll()
• API: PUT /env | POST /env

​

Updating Environment Variables

Update existing environment variables without clearing others.

• Updating Environment Variables - Update environment variables
• SDK: Python: sandbox.env.update() | JavaScript: sandbox.env.update()
• API: PATCH /env

​

Clearing Environment Variables

Remove all environment variables from sandboxes.

• Clearing Environment Variables - Clear all environment variables
• SDK: Python: sandbox.env.clear() | JavaScript: sandbox.env.clear()
• API: DELETE /env

​

SDK Reference

​

Python SDK

Complete reference for Python environment variable operations.

• Environment Variables Module - Complete environment API
  • env.get() - Get single variable
  • env.get_all() - Get all variables
  • env.set() - Set single variable
  • env.set_all() - Set all variables
  • env.update() - Update variables
  • env.clear() - Clear all variables

​

JavaScript SDK

Complete reference for JavaScript/TypeScript environment variable operations.

• Environment Variables Module - Complete environment API
  • env.get() - Get single variable
  • env.getAll() - Get all variables
  • env.set() - Set single variable
  • env.setAll() - Set all variables
  • env.update() - Update variables
  • env.clear() - Clear all variables

​

API Reference

​

VM Agent API

REST API endpoints for environment variable operations.

• VM Agent API Overview - API overview
• Get Environment Variables - GET /env - Get all variables
• Set Environment Variables - PUT /env - Set all variables
• Update Environment Variables - PATCH /env - Update variables
• Clear Environment Variables - DELETE /env - Clear all variables

​

Quick Start

If you’re new to environment variables, start here:

1. Getting Environment Variables - Read environment variables
2. Setting Environment Variables - Set your first variable
3. Updating Environment Variables - Update existing variables

​

Related Topics

• Code Execution - Use environment variables in code
• Sandboxes - Set variables when creating sandboxes
• File Operations - Configure file paths with variables
• Commands - Use variables in shell commands

​

Next Steps

• Learn about Code Execution to use variables in code
• Explore Setting Environment Variables for configuration
• Review Updating Environment Variables for incremental changes
• Check out Sandboxes for initial configuration