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.

Introduced in API version 44.0.

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

  • 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.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
  • Description: Reserved for future use.
  • 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.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: Reserved for future use.
  • Type: date
  • Properties: Filter, Group, Nillable, Sort
  • Description: Date when the scratch org snapshot expires.
  • Type: picklist
  • Properties: Filter, Group, Restricted picklist, Sort
  • Description: For internal use only.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Description: For internal use only.
  • Type: string
  • Properties: Filter, Group, Sort
  • Introduced: API version 59.0
  • Description: For internal use only.
  • 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.
  • Type: string
  • Properties: Create, Filter, Group, Sort
  • Description: The org ID of the scratch org that the snapshot was created from.

  • Type: picklist

  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

  • Description:

    Status of the snapshot.

    The default value is New.

  • Possible values:

    • Active — Active — The snapshot is created and can be used to create scratch orgs.
    • Error — Error — The snapshot couldn’t be created.
    • Expired — Expired — The snapshot has expired.
    • In Progress — In Progress — The snapshot is in the process of being created.
    • New — New (default) — The snapshot creation request has been received.

  • Default value: New

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.