bdy sandbox snapshot create

$bdy sandbox snapshot create|add [options] <identifier>

Create a snapshot of a sandbox Required scopes: SANDBOX_WRITE

ARGUMENTS

identifier

Sandbox identifier (required)

OPTIONS

--context <name>

Connection and scope context: default, git, link or a saved name. Overrides the globally active context for this invocation.

--examples

Show only examples; with this flag --format accepts text, json or jsonl

--verbose

Show REST API requests, responses, timing and retries on stderr

-w, --workspace <domain>

Workspace URL handle. Can be set via variable: BUDDY_WORKSPACE

-p, --project <name>

Project name. Can be set via variable: BUDDY_PROJECT

--scope <scope>

Force scope (WORKSPACE, PROJECT, ENVIRONMENT). By default calculated by provided options and environmental variables (--project,

--environment

BUDDY_PROJECT, linked project)

-e, --environment <identifier>

Environment identifier

-n, --name <name>

Snapshot name (optional, auto-generated if not provided)

--wait [seconds]

Wait until operation completes

--format <text|json>

Output format: json, text. JSON CLI errors: {error:{code,message,hint}}, exit 1. Default: text (choices: "text", "json")

-h, --help

display help for command

Documentation for bdy v1.25.20

Last modified on Oct 14, 2026

Examples

Create snapshot of sandbox with name
bdy sb snap create sandbox-identifier -n "my-snapshot"$

Create snapshot of sandbox and wait for it to complete
bdy sb snap create sandbox-identifier --wait$

Return the result as JSON
bdy sandbox snapshot create my-sandbox --wait --format json$