volumes

A volume: its size, what it occupies, its backups and which sandboxes hold it.

get/v1/volumes/{id}

Request

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

Path parameters

idstring required

Resource identifier (UUID).

Response

Success

idstring required
kind'volume' required
statusstring required
state'creating' | 'ready' | 'failed' | 'deleting' | 'deleted' required
namestring nullable
sizeMiBinteger required
usedMiBinteger nullable
backedUpboolean required

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.

restoredFromstring nullable

The backup this volume was made from.

createdAtstring

Changes

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