SMsmolmachines
checkpoints

Create a checkpoint.

Changed on

Captures the machine's full state as a portable checkpoint. Requires the machine:create scope.

post/v1/machines/{id}/checkpoints

Request

Path parameters

idstring required

Running forkable machine id

Query parameters

waitboolean

Defaults to true. False accepts a background capture; poll checkpoint status before restore.

Response

Portable checkpoint captured

archstring required
createdAtstring required
downloadUrlstring required

Authenticated endpoint that downloads the .smolcheckpoint file.

engineVersionstring nullable

smolvm version of the node that captured it. A restore is only placed on a node at this version or newer. Absent for older checkpoints, which restore anywhere.

idstring required
machineDeletedboolean

The machine it was captured from has been deleted. The checkpoint stays until it is deleted itself, and can still be restored or downloaded.

machineIdstring required
sizeBytesinteger required
statusstring required

creating, uploading, available, failed, or deleting.

Changes