snapshots

Change a snapshot's name or replace its labels.

Omitted fields stay unchanged. An empty labels object clears labels; a null name clears the name. Captured bytes, retention and billing are unchanged.

post/v1/snapshots/{id}:update

Request

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

Path parameters

idstring required

Resource identifier (UUID).

Headers

Idempotency-Keystring

Replaying the same key with the same request within 24 hours returns the first result and never repeats the effect. A refusal is not kept: a request refused before it ran (no_capacity, busy, a limit) runs afresh when sent again with its key. The SDKs send one automatically; the server makes one when absent and returns it in the idempotency-key response header.

Request body

namestring nullable

Your own handle for the resource. Letters, digits, dot, dash, underscore.

labelsobject

Your own key/value tags, at most 32. Filter lists with label=key:value.

ifLabelsobject

Only update if the current complete labels equal these; otherwise snapshot_metadata_changed. Omit for an unconditional update.

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.