Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xano.com/llms.txt

Use this file to discover all available pages before exploring further.

The sandbox is an isolated copy of your workspace where you can push and test changes without affecting your live environment. Once you’re satisfied, you can review and promote changes from the sandbox to your workspace through the browser.
Sandbox commands operate on your personal sandbox environment, which is tied to your profile. You don’t need to specify a workspace or tenant — the CLI manages this automatically.

Get Your Sandbox

This returns your sandbox details. If you don’t have one yet, it creates one automatically. Use -o json for the full JSON response.

Pull & Push

The sandbox supports the same pull and push workflow as workspace pull & push, using the multidoc format behind the scenes.

Pull from Sandbox

FlagDescription
--envInclude environment variables
--recordsInclude database records
--draftInclude draft versions of resources

Push to Sandbox

By default, only changed files are pushed (partial mode). Like workspace push, sandbox push runs a preview and prompts for confirmation before applying anything.
FlagDescription
--syncFull push — send all files, not just changed ones (required for --delete)
--deleteDelete sandbox objects not present locally (requires --sync)
--recordsInclude database records in import
--envInclude environment variables in import
--dry-runShow the push preview, then exit without applying
--forceSkip the preview and confirmation prompt
--no-guidsSkip writing server-assigned GUIDs back to local files
--no-transactionSkip wrapping the import in a database transaction
--truncateTruncate all table records before importing
--reviewOpen the sandbox review in your browser after pushing
Unlike xano workspace push, sandbox push does not support the -i/--include or -e/--exclude filters. Pushing only a subset of files can hide deletions during sandbox review, which risks dropping tables when the review is promoted to your workspace — so the sandbox always pushes the full set of changed files.

Workspace mismatch guard

To catch the case where your local files belong to a different workspace than the one currently loaded on your sandbox, the CLI compares the workspace named in your local files against the sandbox’s loaded workspace. If they differ and the push contains a significant number of changes (25 or more), it shows a Workspace Mismatch warning and asks you to confirm before continuing. Declining cancels the push and suggests running xano sandbox reset to clear the sandbox first. In non-interactive environments (CI/CD, piped output), a mismatch causes the command to error unless you pass --force.
This is the recommended way to deploy changes to tenants. Instead of pushing directly to a tenant (which is not supported), push to your sandbox first, review the changes, then promote them.

Review & Promote

Open your sandbox in the browser to review changes and promote them to the workspace: To get the URL without opening the browser (useful for scripting): If your instance uses a self-signed TLS certificate, add --insecure (-k) to skip certificate verification for this command — mirroring xano auth --insecure:
--insecure disables TLS certificate verification, which exposes the connection to man-in-the-middle attacks. Use it only for one-off access against self-signed certificates in local development.

Reset

Reset your sandbox to clear all workspace data and drafts, returning it to a clean state: Add -f to skip the confirmation prompt.
Resetting a sandbox clears all data and drafts. This cannot be undone.

Delete

Delete your sandbox environment entirely. It will be re-created automatically the next time you access it. Add -f to skip the confirmation prompt.

Environment Variables

Manage environment variables on your sandbox, just like tenant environment variables.

List Env Var Keys

Get a Single Env Var

Set an Env Var

Delete an Env Var

Export All Env Vars

Export all environment variables to a YAML file:

Import All Env Vars

Import environment variables from a YAML file (replaces existing):

Sandbox License


Sandbox Tests

Run unit tests and workflow tests against your sandbox environment.

Unit Tests

Filter by branch or object type:

Workflow Tests

Filter by branch with -b:

Typical Workflow

A common pattern for deploying changes through the sandbox:
1

Pull your workspace

2

Make changes locally

Edit .xs files in your editor or with AI tools.
3

Push to your sandbox

4

Test in the sandbox

Review and test your changes in the sandbox environment.
5

Promote to your workspace

Open the sandbox in the browser to review and promote: