Skip to main content
DEPRECATED: Use API Box for APIs and Web Box for web apps Starts saving a running Simulation’s current state and returns the Snapshot with status creating. Poll it until it is ready, or failed with an error. Saving closes the Simulation’s open event streams and WebSockets and does not change its state; while it saves, an advance returns 409 clock_conflict, and a stop waits for it. Create Simulations from a ready Snapshot with snapshot_id; it outlives its Simulation. A stopped Simulation returns 409 simulation_stopped. Reuse the Idempotency-Key to retry safely. Deprecated. Use API Box for APIs and Web Box for web apps.

Examples

Flags

string
Request body as JSON (alternative to individual flags). Can also be provided via stdin.
string
Optional key for retrying this create safely. A retry with the same key and request returns the original result with its status; the same key with a different request returns 409 idempotency_conflict. Without a key, each request creates a new resource.
string
required
Snapshot name.
string
required
ID of the running Simulation to save.
Global flags apply to every command. See Global flags.