Sandbox Environments

Yboard provides sandbox environments — isolated, stateful containers where your app runs during development. Each sandbox manages its own files, secrets, configurations, and deployment state.

Sandbox lifecycle

Pause and resume

Sandboxes can be paused to save resources and resumed when needed:

Pause — Schedules the sandbox to stop after a delay. Accepts a delaySeconds parameter.
Resume — Immediately restarts a paused sandbox.

Pausing is useful for apps with intermittent usage. The sandbox state (files, secrets, configuration) is preserved while paused.

State management

Each sandbox maintains a state object that tracks:

Environment configurations — Separate state for dev, preview, and production.
Dev deploy map — Tracks development deployments.
Navigations — UI navigation state.

State can be updated with merge mode (deep merges into existing state) or replace mode (overwrites entirely). Merge mode is the default and handles nested environment objects intelligently.

Secrets per environment

Secrets in sandboxes are scoped to environments, allowing different configurations for development, preview, and production:

List secrets for an environment

# Default: development environment
curl https://worker.yboard.app/{orgId}-{appId}/secrets?environment=development \
  -H "Authorization: Bearer YOUR_API_KEY"

# Production secrets
curl https://worker.yboard.app/{orgId}-{appId}/secrets?environment=production \
  -H "Authorization: Bearer YOUR_API_KEY"

Set secrets

curl -X POST https://worker.yboard.app/{orgId}-{appId}/secrets \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "secrets": [
      { "name": "API_KEY", "value": "abc123" },
      { "name": "DB_HOST", "value": "localhost" }
    ]
  }'

Update a single secret

curl -X PUT https://worker.yboard.app/{orgId}-{appId}/secrets/API_KEY \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "value": "new-value",
    "environment": "production"
  }'

Sandbox files

Sandboxes have their own file storage, separate from the main file management system:

List files — View all files in the sandbox.
Save files — Write files to the sandbox.
Bulk upload — Upload multiple files at once via the /upload-files-to-sandbox endpoint.

Dev server connections

Each sandbox can have active development server connections. You can:

List connections — See all active connections to the sandbox.
Disconnect — Force-disconnect dev server connections when needed.

Sandbox configuration

Sandboxes expose configuration through several endpoints:

Endpoint	Description
`GET /configs`	Retrieve key-value configurations
`GET /domains`	List domains assigned to the sandbox
`POST /domains`	Add a development domain
`GET /connections`	List active connections
`GET /messages`	Retrieve sandbox messages
`GET /app`	Get app information
`GET /access-token`	Get an access token for the sandbox

Deployment from sandbox

Sandboxes support a deployment flow where changes move through environments:

Dev — Active development in the sandbox.
Preview — Deployed for testing with isolated database and secrets.
Production — Live deployment accessible to users.

Each environment has its own worker script, secrets, and database branch. Use the POST /post-deploy-worker endpoint to trigger post-deployment processing.

Overview

Core Features

App Management

Integrations

Sandbox Environments

Sandbox lifecycle

Pause and resume

State management

Secrets per environment

List secrets for an environment

Set secrets

Update a single secret

Sandbox files

Dev server connections

Sandbox configuration

Deployment from sandbox

​Sandbox lifecycle

​Pause and resume

​State management

​Secrets per environment

​List secrets for an environment

​Set secrets

​Update a single secret

​Sandbox files

​Dev server connections

​Sandbox configuration

​Deployment from sandbox

Sandbox lifecycle

Pause and resume

State management

Secrets per environment

List secrets for an environment

Set secrets

Update a single secret

Sandbox files

Dev server connections

Sandbox configuration

Deployment from sandbox