Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Backups

List cloud backups

List cloud backups for given site

get/v1/sites/{id}/cloud_backups

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

searchstring

Searches for backups with properties matching this string

Example:WooCommerce Upgrade
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_idstring uuid

ID of this task

Example:01d680d5-de78-4e26-a380-5f7ad2c0877f
pageinteger

Page of results to include (default = 1)

per_pageinteger

How many results to include in each page

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

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "id": "8d8ac610-566d-4ef0-9c22-186b2a5ed793",
      "includes_files": true,
      "label": "April 3rd Backup - Before Plugin Updates",
      "site_id": 8880000888,
      "size": 1024,
      "task_id": "60f248b2-5fd3-482a-bf40-845d2e0c909a",
      "wordpress_metadata": {
        "wordpress": {
          "version": "6.4.1",
          "php_version": "8.2"
        }
      },
      "zip_file_name": "example.com_backup_2025-09-21T12-00-01.zip"
    }
  ]
}