--- schema_version: "1" id: 79aae7ff9695cf54ee4050243333063e844b28407f4f323c9ad53fbc165209e6 title: OrgSnapshot collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_orgsnapshot.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orgsnapshot.htm source_site: developer.salesforce.com content_type: documentation content_hash: 97a5a0e8f5dbff76bc0b25bdc1996212d7f42e7769c7fb5477acc74d8b3bbb20 description: 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. --- # 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [OrgSnapshotHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [OrgSnapshotShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.