v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB

Backups

Get a list of backups for site

For a given site list all manually created backups

get/v1/sites/{id}/backup

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

task_idstring

Filter results by task_id (cannot be combined with other filters)

searchstring

Filter results by backup label

statusstring

One or more statuses to filter by. If more than one status, use a comma-separated list

Example:DONE,RESTORING

pageinteger

Page of results to include (default = 1)

per_pageinteger

How many results to include in each page

sort'created_at' | 'id' | 'label' | 'status'

Sort results by the following property

direction'asc' | 'desc' | 'ASC' | 'DESC'

Direction to sort results in (asc = ascending, desc = descending)

Response

successboolean

whether the request succeeded

errorsstring[]

messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "id": 8880000888,
      "label": "April 3rd Backup - Before Plugin Updates",
      "created": "2024-01-01T12:01:05.986Z",
      "site_id": 8880000888,
      "task_id": "60f248b2-5fd3-482a-bf40-845d2e0c909a"
    }
  ]
}