SandboxInfo | Force.com Tooling API | Salesforce Developers

SandboxInfo enqueues a sandbox for creation or refresh. A create operation on SandboxInfo represents creation of a new sandbox, and an update represents refresh of an existing sandbox. For every create or update, a SandboxProcess is automatically created and is used for monitoring the sandbox copy process.

This object is available in API version 35.0 and later.

Supported SOAP Calls

create(), delete(), query(), retrieve(), update()

Supported REST HTTP Methods

GET, PATCH, POST, DELETE

Fields

Field	Details
ApexClassId	Type ID Properties Create, Filter, Group Description An Apex class that runs after each copy of the sandbox, allowing you to perform business logic on the sandbox to prepare it for use. Restrictions Must be specified during sandbox creation. The class must extend the `System.SandboxPostCopy` interface. Available in API version 36.0 and later.
AutoActivate	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If `true`, you can activate a sandbox refresh immediately. Restrictions This field only affects behavior for update operations (Sandbox refresh).
CopyArchivedActivities	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update 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 only set the value to `true` for a Full sandbox.
CopyChatter	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If `true`, archived Chatter data is copied to the sandbox. Restrictions You can only set the value to `true` for a Full sandbox.
Description	Type string Properties Create, Filter, Nillable, Sort, Update Description A description of the sandbox, which is useful if you have more than one sandbox. Restrictions Description can’t exceed 1,000 characters.
HistoryDays	Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Represents the number of days of object history to be copied in the sandbox. Valid values: `-1`, which means all available days `0` (default) `10` `20` `30` `60` `90` `120` `150` `180` Restrictions This field only affects behavior for Full sandboxes.
LicenseType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Represents the sandbox license type. Valid values: `DEVELOPER` `DEVELOPER_PRO` `PARTIAL` `FULL`
SandboxName	Type string Properties Create, Filter, Group, idLookup, Unique, Update Description Name of the sandbox. Restrictions Must be a unique sandbox name. Must be alpha-numeric characters. Must be ten or fewer characters. Can’t be the same as a pending deleted sandbox.
TemplateId	Type ID Properties Create, Filter, Nillable, Sort, Update Description ID of the sandbox template associated with this sandbox. A sandbox template lets you select which objects to copy in a sandbox. Restrictions Setting a value for a Partial Copy sandbox is required. Setting a value for a Full sandbox is optional. Setting a value for other sandbox types is prohibited, because other sandbox types don’t support sandbox templates.

Usage

SandboxInfo and SandboxProcess work together to manage the creation or refresh of a sandbox.