snapshots

A snapshot: its state, the machine it starts, what it stores and when it expires.

get/v1/snapshots/{id}

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/snapshots/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Resource identifier (UUID).

Response

Success

idstring required
kind'snapshot' required
mode'memory' | 'disk'
statusstring required
state'capturing' | 'ready' | 'failed' | 'deleting' | 'deleted' required
namestring nullable
sourceSandboxIdstring required
placementstring nullable

Opaque tag of the server it is kept on, as a sandbox's placement: its copies start there, or on a server holding a checked copy of it. Keep sources on separate servers with spreadFrom on create.

retentionDaysinteger nullable

Days it is kept, or null: kept while your account has credit, up to a year from when it was taken.

compressionPendingboolean

True while raw fork memory awaits verified compression. Ready snapshots remain startable on their current host. This workspace is unbilled and has no off-host copy until final publication; cross-host copies wait for compression.

storedBytesinteger nullable
meteredBytesinteger nullable

What storage is metered for: the final bytes this snapshot alone stores. Zero while compressionPending is true.

backedUpboolean

Whether its copy off the host is made and checked.

errorstring nullable
createdAtstring
readyAtstring nullable
expiresAtstring nullable required

When it is deleted. Null while it is kept as long as your account has credit.

Changes

No recorded changes to this operation across all 1 revision of this API.