---
title: "List cloud backups"
method: GET
path: "/v1/sites/{id}/cloud_backups"
tags: ["Backups"]
---

# List cloud backups

`GET /v1/sites/{id}/cloud_backups`

List cloud backups for given site

## Path parameters

- `id` integer, required — ID of the Site you are interacting with

## Query parameters

- `search` string — Searches for backups with properties matching this string
- `status` 'NEW' | 'PROGRESS' | 'DONE' | 'ERROR' | 'RESTORING' — Status of the backup (NEW - task created, PROGRESS - backup in progress, DONE - backup complete, ERROR - backup failed, RESTORING - backup currently being restored)
- `task_id` string, uuid — ID of this task
- `page` integer — Page of results to include (default = 1)
- `per_page` integer
- `sort` 'created_at' | 'status' | 'id' | 'label' | 'task_id' — Sort results by the following property
- `direction` 'asc' | 'desc' | 'ASC' | 'DESC' — Direction to sort results in (asc = ascending, desc = descending)

## Response `200`

OK

- ListCloudBackupsResponse
  - `success` boolean — whether the request succeeded
  - `errors` string[]
  - `messages` string[], nullable
  - `metadata` object
    - `page` integer — Page number of the results
    - `page_size` integer — Number of results per page
    - `total` integer — Total number of results
    - `sort` string — Sorting criteria
    - `direction` 'asc' | 'desc' — Sorting direction
  - `result` CloudBackup[]
    - `id` string, uuid — ID of the backup
    - `includes_files` boolean — Whether the backup includes all the files from the site
    - `includes_database` boolean — Whether the backup includes database contents
    - `created_at` string, date-time — Date and time the backup was created
    - `label` string — Label / Name of the backup
    - `status` 'NEW' | 'PROGRESS' | 'DONE' | 'ERROR' | 'RESTORING' — Status of the backup (NEW - task created, PROGRESS - backup in progress, DONE - backup complete, ERROR - backup failed, RESTORING - backup currently being restored)
    - `site_id` integer — ID of the site the backup is a backup of
    - `size` integer — Size of the backup in bytes
    - `task_id` string, uuid — ID of the task that was used to create this backup
    - `wordpress_metadata` WordPressMetadata — properties about the WordPress site
      - `wordpress` object — WordPress properties
        - `version` string — version of WordPress that the site was running
        - `php_version` string, nullable — version of PHP that the site was running
        - `plugins` WordPressPluginOrTheme[]
          - `name` string
          - `title` string
          - `version` string
          - `activated` boolean
        - `themes` WordPressPluginOrTheme[]
          - `name` string
          - `title` string
          - `version` string
          - `activated` boolean
    - `zip_file_name` string — Name of the zip file that was created for this backup

## Other responses

- `400` — Bad Request
- `401` — Authentication failed
- `403` — Not authorized to access endpoint
- `404` — Given site not found for user
- `405` — Invalid input
- `500` — Internal error

---

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