Skip to main content
PATCH
Update Simulation Snapshot

Authorizations

Authorization
string
header
required

Use a Continuous API key. Send it in the Authorization header as a Bearer token.

Path Parameters

id
string
required

Snapshot ID.

Pattern: ^sns_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
name
string

New Snapshot name.

Required string length: 1 - 128

Response

OK

created_at
string<date-time>
required

Snapshot creation time.

current_time
string<date-time> | null
required

Simulated time of the saved state, where a Simulation created from the Snapshot starts, or null until it is ready.

error
object | null
required

Why the save failed, or null unless status is failed.

id
string
required

Snapshot ID.

Pattern: ^sns_[0-9A-HJKMNP-TV-Z]{26}$
name
string
required

Snapshot name. The ID is its identity, and names need not be unique.

Maximum string length: 128
simulation_id
string | null
required

ID of the Simulation the Snapshot saved, or null once that Simulation is deleted.

Pattern: ^sim_[0-9A-HJKMNP-TV-Z]{26}$
simulation_name
string | null
required

Current name of the Simulation the Snapshot saved, or null once that Simulation is deleted.

simulator_id
string
required

ID of the Simulator a Simulation created from the Snapshot runs, at the digest its source pinned.

Pattern: ^smr_[0-9A-HJKMNP-TV-Z]{26}$
start_time
string<date-time> | null
required

Initial simulated time of a Simulation created from the Snapshot, or null until it is ready.

status
enum<string>
required

creating while the state is saved. A Simulation can start from a ready Snapshot. A failed Snapshot holds no state.

Available options:
creating,
ready,
failed