v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB

Backups

List automated backups

List automated backup recovery points from the system

get/v1/sites/{id}/backup/automated

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

searchstring

Searches for backups with created_at matching this string

status'DONE' | 'RESTORING'

Status of the backup (DONE - backup complete, RESTORING - backup currently being restored)

pageinteger

Page of results to include (default = 1)

per_pageinteger

How many results to include in each page

sort'created_at' | '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": [
    {
      "recoveryPoint": "6584164ed698071fa305ed4a",
      "created_at": "2024-08-16T10:09:20+00:00"
    }
  ]
}