---
title: "List Backups"
method: GET
path: "/v1/backups"
tags: ["Backups"]
---

# List Backups

`GET /v1/backups`

## Query parameters

- `limit` integer
- `startingAfter` string, uuid
- `sortBy` 'id' | 'alias' | 'metadata.createdAt' | 'metadata.lastModifiedAt'
- `sortOrder` 'ASC' | 'DESC'
- `vaultId` string, uuid
- `lastOnly` boolean
- `acknowledged` boolean
- `data.type` 'VaultHsm' | 'VaultMpc'
- `metadata.createdBy` string, uuid
- `metadata.lastModifiedBy` string, uuid
- `metadata.description` string
- `metadata.customProperties` string[]
- `additionalDetails.processingStatus` 'Pending' | 'Preparing' | 'Completed' | 'Failed'

## Response `200`

- CoreBackupsCollection
  - `items` CoreApiBackup[], required
    - `id` string, uuid, required
    - `data` union, required
      - CoreApiBackupDataVaultHSM
        - `vaultId` string, uuid, required
        - `acknowledged` boolean, required
        - `type` 'VaultHSM', required
      - CoreApiBackupDataVaultMPC
        - `vaultId` string, uuid, required
        - `acknowledged` boolean, required
        - `type` 'VaultMPC', required
    - `metadata` CoreEntityMetadata, required
      - `description` string
      - `revision` integer, required
      - `createdAt` string, date-time, required
      - `createdBy` CoreUserReference
        - `id` string, uuid, required
        - `domainId` string, uuid, required
      - `lastModifiedAt` string, date-time, required
      - `lastModifiedBy` CoreUserReference
        - `id` string, uuid, required
        - `domainId` string, uuid, required
      - `customProperties` CoreStringsMap, required
    - `additionalDetails` CoreBackupAdditionalDetails
      - `processing` union, required
        - CoreBackupProcessingDetailsCompleted
          - `status` 'Completed', required
        - CoreBackupProcessingDetailsFailed
          - `status` 'Failed', required
        - CoreBackupProcessingDetailsPending
          - `status` 'Pending', required
        - CoreBackupProcessingDetailsPreparing
          - `status` 'Preparing', required
  - `count` integer, required
  - `currentStartingAfter` string
  - `nextStartingAfter` string

## Other responses

- `400` — Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter vaultId, Invalid value for: query parameter lastOnly, Invalid value for: query parameter acknowledged, Invalid value for: query parameter data.type, Invalid value for: query parameter metadata.createdBy, Invalid value for: query parameter metadata.lastModifiedBy, Invalid value for: query parameter metadata.description, Invalid value for: query parameter metadata.customProperties, Invalid value for: query parameter additionalDetails.processingStatus
- `401` — One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)
- `404` — Entity or Domain not found (EntityNotFoundError)

---

[API](https://skmtc.net/ripple/apis/ripple-custody-api.md) · [All operations](https://skmtc.net/ripple/apis/ripple-custody-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripple-custody-api/revisions/0b55c0ddf07a/schema)