OrgSnapshot

Represents a snapshot of a scratch org. Snapshots capture the state of a scratch org so that you can use it to quickly spin up new scratch orgs using its configuration. This object is available in API version 61.0 and later.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

A snapshot must belong to the Dev Hub org that you’re using to create the scratch org. You must enable the scratch org snapshot feature in your Dev Hub org using Setup.

Fields

Field	Details
Content	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reserved for future use.
Description	Type textarea Properties Create, Filter, Group, Nillable, Sort Description A free-form text field (maximum 255 characters) for you to enter a description of this scratch org snapshot.
Error	Type string Properties Filter, Group, Nillable, Sort Description Reserved for future use.
ExpirationDate	Type date Properties Filter, Group, Nillable, Sort Description Date when the scratch org snapshot expires.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns the scratch org snapshot. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
Provider	Type picklist Properties Filter, Group, Restricted picklist, Sort Description For internal use only.
ProviderSnapshot	Type string Properties Filter, Group, Nillable, Sort Description For internal use only.
ProviderSnapshotVersion	Type string Properties Filter, Group, Sort Description For internal use only.
SnapshotName	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the scratch org snapshot. This field value is unique within your org.
SourceOrg	Type string Properties Create, Filter, Group, Sort Description The org ID of the scratch org that the snapshot was created from.
Status	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Status of the snapshot. Possible values are: `Active`—The snapshot is created and can be used to create scratch orgs. `Error`—The snapshot couldn’t be created. `Expired`—The snapshot has expired. `In Progress`—The snapshot is in the process of being created. `New`—The snapshot creation request has been received. The default value is `New`.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

OrgSnapshotFeed: Feed tracking is available for the object.
OrgSnapshotHistory: History is available for tracked fields of the object.
OrgSnapshotShare: Sharing is available for the object.

Login

Products

Experiences

Agentforce

CRM Products

Industries

Small Business

Data

Salesforce Platform

Customer Success

Partner Apps & Experts

Discover the #1 AI CRM

Discover the #1 AI CRM

Automotive

Communications

Engineering, Construction & Real Estate

Consumer Goods

Education

Energy & Utilities

Financial Services

Healthcare & Life Sciences

Manufacturing

Media

Nonprofit

Professional Services

Public Sector

Retail

Technology

Travel, Transportation & Hospitality

Explore Salesforce for industries.

Explore Salesforce for industries.

Customer Stories

Salesforce on Salesforce Stories

Trailblazer Stories

Explore success stories.

Explore success stories.

Learning on Trailhead

Events

Resources

Blogs

Become a Trailblazer.

Become a Trailblazer.

Help & Documentation

Communities

Services & Plans

Your Account

Questions? We can help.

Questions? We can help.

About Salesforce

Our Values

Our Impact

Careers

Newsroom

Legal

More Salesforce Brands

Hear our story.

Hear our story.

Events

Original Series

My List

Explore Salesforce+.

Explore Salesforce+.

Login

Products

Experiences

Contact Us

By phone

Online

Products

Experiences

Developer Centers

Salesforce Platform

Industries

Resources

Developer Tools

Build Skills

Extend Salesforce

Stay Up To Date

Community

Object Reference for the Salesforce Platform