volumes

Delete a volume and everything on it. Refused while a sandbox holds it. Its backups are kept for their retention.

post/v1/volumes/{id}:delete

Request

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

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.