volumes

Back a volume up now, off its host.

The backup is a crash-consistent point in time, taken while sandboxes may be writing. It is ready once copied off the host and checked; send Prefer: wait=60 to wait for it. A volume lives on one host's disks. It is backed up off that host daily unless you turn that off, and whenever you ask; backedUp is true once a backup has been copied off the host and checked. Writes since the last backup are not in it. A backup is crash-consistent: what a program had not yet written to the disk is not in it.

post/v1/volumes/{id}:backup

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/volumes/{id}:backup
  • 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

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.

retentionDaysinteger

Days to keep it, 1 to 365; the volume's backup retention (7 unless set) when omitted.

Response

Success

idstring required
kind'volume-backup' required
statusstring required
state'pending' | 'ready' | 'failed' | 'deleting' | 'deleted' required
namestring nullable
volumeIdstring required
sizeMiBinteger required

The volume's size when backed up; a restore is this size.

trigger'manual' | 'daily'
retentionDaysinteger
storedBytesinteger nullable

What it keeps off the host, compressed and encrypted.

errorstring nullable
errorCodestring nullable

Why it failed, when a code says it: backup_stalled when its copy off the host never began. Back it up again.

createdAtstring
copyStartedAtstring nullable

When its copy off the volume's server began; null while it waits its turn behind other copies there.

readyAtstring nullable
expiresAtstring required

Changes

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