---
title: "List volume backups, newest first, optionally those of one volume."
method: GET
path: "/v1/volume-backups"
tags: ["volumes"]
---

# List volume backups, newest first, optionally those of one volume.

`GET /v1/volume-backups`

## Request

- Base URL: `https://api.withruntime.com`
- URL: `https://api.withruntime.com/v1/volume-backups`
- Auth: HTTP bearer

## Query parameters

- `volumeId` string: Resource identifier (UUID).
- `cursor` string: Resource identifier (UUID).
- `limit` integer: Page size, 1 to 100.
- `state` 'pending' | 'ready' | 'failed' | 'deleting'

## Response `200`

Success

- object
  - `data` object[], required
    - `id` string, required
    - `kind` 'volume-backup', required
    - `status` string, required
    - `state` 'pending' | 'ready' | 'failed' | 'deleting' | 'deleted', required
    - `name` string, nullable
    - `volumeId` string, required
    - `sizeMiB` integer, required: The volume's size when backed up; a restore is this size.
    - `trigger` 'manual' | 'daily'
    - `retentionDays` integer
    - `storedBytes` integer, nullable: What it keeps off the host, compressed and encrypted.
    - `error` string, nullable
    - `errorCode` string, nullable: Why it failed, when a code says it: backup_stalled when its copy off the host never began. Back it up again.
    - `createdAt` string
    - `copyStartedAt` string, nullable: When its copy off the volume's server began; null while it waits its turn behind other copies there.
    - `readyAt` string, nullable
    - `expiresAt` string, required
  - `nextCursor` string, nullable, required: Pass as cursor; null ends the list.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/withruntime/apis/runtime-cloud-api.md) · [All operations](https://skmtc.dev/withruntime/apis/runtime-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/withruntime/apis/runtime-cloud-api/revisions/6f4012286988?raw)