SandboxProcess | Tooling API | Salesforce Developers

When you create a SandboxInfo record, a corresponding SandboxProcess record is created. The latest SandboxProcess record for a SandboxInfo record represents the current state of the sandbox.

This object is available in API version 35.0 and later.

Supported SOAP Calls

query(), retrieve(), update()

Supported REST HTTP Methods

GET, PATCH

Fields

Except for RefreshAction, all fields are read only. The read-only fields represent the attributes chosen on SandboxInfo when a copy process was enqueued, or represent the state of the process for monitoring purposes.

Field	Details
ActivatedById	Type reference Properties Filter, Group, Nillable, Sort Description A reference to the ID of the user who requested sandbox activation.
ActivatedDate	Type dateTime Properties Filter, Nillable, Sort Description Represents when the sandbox was activated during a refresh.
ApexClassId	Type reference Properties Filter, Group, Nillable, Sort Description A reference to the ID of an Apex class to run after each copy of the sandbox. Running this class allows you to perform DML operations on the sandbox to prepare it for use. This field can be specified only during sandbox creation. The class must extend the `System.SandboxPostCopy` interface. Available in API version 36.0 and later.
AutoActivate	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Represents whether the sandbox refresh is configured to activate immediately upon completion.
CopyArchivedActivities	Type boolean Properties Defaulted on create, Filter, Group, Sort Description If `true`, archived activity data is copied to the sandbox. Restrictions This field is visible only if your organization has purchased an option to copy archived activities for sandbox. To obtain this option, contact Salesforce Customer Support. You can set the value to `true` only for a Full sandbox.
CopyChatter	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Represents whether archived Chatter data is copied to the sandbox.
CopyProgress	Type int Properties Filter, Group, Nillable, Sort Description Represents how much of a copy has been completed. Available for Developer, Developer Pro, and Full sandboxes. Not available for Full or Partial sandboxes created from sandbox templates.
Description	Type string Properties Filter, Nillable, Sort Description A description of the sandbox, which helps you distinguish it from other sandboxes.
EndDate	Type dateTime Properties Filter, Nillable, Sort Description Represents when the sandbox copy process finished.
HistoryDays	Type int Properties Defaulted on create, Filter, Group, Sort Description Represents the number of days of object history to be copied in the sandbox. Valid values: `-1`, which means all available days `0` `10` `20` `30` `60` `90` `120` `150` `180`
LicenseType	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The sandbox license type. Valid values: `DEVELOPER` `DEVELOPER_PRO` `PARTIAL` `FULL`
RefreshAction	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description Editing this field activates or discards a sandbox refresh. Valid values: `ACTIVATE` `DISCARD` Restrictions If all the following are true, you can activate or discard a sandbox refresh by editing the value in this field. This record is the latest SandboxProcess record. The associated sandbox has been refreshed. This record’s Status is `Pending Activation`.
SandboxInfoId	Type reference Properties Filter, Group, Nillable, Sort Description A reference to the ID of the SandboxInfo being processed (create or refresh).
SandboxName	Type string Properties Filter, Group, idLookup, Sort Description The name of the sandbox.
SandboxOrganization	Type string Properties Filter, Group, Nillable, Sort Description The ID of the org created by the copy process. This field is available in API version 37.0 and later.
SourceId	Type reference Properties Filter, Group, Nillable, Sort, Update Description A reference to the ID of the SandboxInfo that this sandbox is a clone of. This field is used only when cloning a sandbox. When this field is used, LicenseType must be null. Your source sandbox must be an existing, completed sandbox, that belongs to the same production org as the sandbox you’re creating or refreshing. Your SourceId value can’t be the same SandboxInfo that you’re updating. Available in API version 37.0 and later.
StartDate	Type dateTime Properties Filter, Nillable, Sort Description Represents when the sandbox copy process started.
Status	Type string Properties Filter, Group, Nillable, Sort Description Current state of the sandbox copy process. Possible values include: Activating Completed Deleted Deleting Discarding Locked Locking Pending Pending Activation Processing Sampling Stopped Suspended
TemplateId	Type reference Properties Filter, Group, Nillable, Sort Description A reference to the ID of the PartitionLevelScheme that represents the sandbox template associated with the sandbox for this process. A sandbox template selects which objects to copy in a sandbox.

Usage

SandboxInfo represents a sandbox, and SandboxProcess represents the sandbox copy process, which occurs when you create a sandbox or refresh it. You can also delete a sandbox.

Creating a Sandbox

To enqueue a new sandbox:

Create a SandboxInfo record.
To find the status of a sandbox after it is enqueued, query SandboxProcess for a given SandboxInfoId field to find the latest SandboxProcess record. The value of Completed in Status indicates that the creation process is finished.

Refreshing a Sandbox

To refresh a sandbox:

To start a sandbox refresh, edit the SandboxInfo record.
To find the status of a sandbox after it is enqueued, find the latest SandboxProcess record by querying SandboxProcess for a given SandboxInfoId value. The value of Status indicates the current state of the process.
When the Status field value is Pending Activation, change the value of the RefreshAction field to either ACTIVATE or DISCARD.

Deleting a Sandbox

To delete a sandbox, delete the SandboxInfo record that represents the sandbox. Deleting the SandboxInfo record deletes the sandbox and frees up a license.