1 of 1

Create Sandbox

Create a new Salesforce sandbox org.

sfp-pro

sfp (community)

Availability

✅

❌

From

August 24

This command creates a new sandbox org from a source org (production or another sandbox). You can specify the sandbox configuration using command-line options or a definition file.

Usage

$ sfp sandbox:create -v <string> -n <string> -s <string> [flags]
$ sfp org:create:sandbox -v <string> -n <string> -s <string> [flags]

Flags

Flag

Required

Description

-v, --targetdevhubusername=<value>

Username or alias of the production org

-n, --name=<value>

Yes (if no definition file)

Name of the sandbox to create

-s, --sourcesandbox=<value>

Name of the source sandbox to clone

-f, --definition-file=<value>

Path to a sandbox definition file

-d, --description=<value>

Description of the sandbox

--json

Format output as JSON

--loglevel=<option>

Logging level for this command invocation

Examples

$ sfp sandbox:create -v MyDevHub -n MySandbox1 -s SourceSandbox

Sandbox Definition File

If using a definition file, create a JSON file (default location: config/sandbox-def.json) with the following structure:

{
  "sandboxName": "MySandbox",
  "description": "My sandbox description",
  "sourceSandbox": "SourceSandboxName",
  "apexClassId": "01p...",
  "autoActivate": true,
  "copyChatter": true,
  "copyArchivedActivities": true,
  "licenseType": "Developer",
  "templateId": "0TT...",
  "historyDays": 0
}

Note: When using a definition file, the --name and --sourcesandbox flags are ignored.