DemandFlow Support Centre

VMSNAPSHOT: VM Snapshot

A point-in-time snapshot of a virtual machine's disk and optionally memory state, enabling rollback and cloning.

Default definition. This article describes the default VMSNAPSHOT definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches VMSNAPSHOT.

Entity properties

Property	Value
Entity code	`VMSNAPSHOT`
Display name	VM Snapshot
Plural	VM Snapshots
Level	340

Use cases

A point-in-time snapshot of a virtual machine's disk and optionally memory state, enabling rollback and cloning.

VMSNAPSHOT is a child of COMPINV (VM) via comboKey (SUB|COMPINV). Snapshots form a tree via the parentSnapshot self-referential lookup. each snapshot branches from a parent, and only one can be the current active point (isCurrent). The includesMemory flag distinguishes quick disk-only snapshots from full memory+disk captures. The quiesced flag indicates whether guest-level filesystem quiescing (VSS on Windows, fsfreeze on Linux) was used to ensure application consistency. Snapshot size grows over time as the delta disk accumulates writes, so sizeGB is tracked for capacity planning and stale snapshot detection.

Fields

Snapshot Information

Field	Type	Required	Notes
`name`	text	Yes	Snapshot Name.
`description`	text (multi-line)		Description.
`vm`	reference → `COMPINV`		Virtual Machine.
`parentSnapshot`	reference → `VMSNAPSHOT`		Snapshot this was branched from
`status`	enum	Yes	Valid ids: `1` (Active), `2` (Consolidating), `3` (Deleted), `4` (Error).
`isCurrent`	boolean		This is the active snapshot point the VM is running from

Details

Field	Type	Notes
`snapshotDate`	datetime	Created.
`createdBy`	reference → user	Created By.
`sizeGB`	number	Delta disk size. grows as VM writes accumulate Read only.
`includesMemory`	boolean	Memory state was captured
`quiesced`	boolean	Guest filesystem was quiesced (application-consistent)
`datastore`	reference → `DATASTORE`	Datastore holding the snapshot delta files
`powerStateAtSnapshot`	enum	Valid ids: `1` (Powered On), `2` (Powered Off), `3` (Suspended).
`expiryDate`	date	When this snapshot should be reviewed for deletion

Attachments and additional panels

Activity timeline panel attached.

Relationships

Lookups: vm points at a COMPINV record; parentSnapshot points at a VMSNAPSHOT record; datastore points at a DATASTORE record.
Related lists: VMSNAPSHOT via objectRef.

Creating a VM Snapshot via the API

POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json

{
  "entity":   "VMSNAPSHOT",
  "level":    340,
  "comboKey": "SUB:<your-sub-id>|ENT:",
  "name": "Example name",
  "status": 1
}

Listing VM Snapshots

GET /v1/entities/VMSNAPSHOT/SUB

DemandFlow Support Centre

VMSNAPSHOT: VM Snapshot

VMSNAPSHOT: VM Snapshot

Entity properties

Use cases

Fields

Attachments and additional panels

Relationships

Creating a VM Snapshot via the API

Listing VM Snapshots

See also

Was this article helpful?