Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Backups

Restore cloud backup / Create new site from backup

Restore a cloud backup to an existing site or create a new site from the backup - Via A Task

post/v1/sites/{id}/cloud_backups/{backup_id}/restore

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888
backup_idstring required

Request body

includes_filesboolean required

Whether to restore the files from the backup

includes_databaseboolean required

Whether to restore the database from the backup

restore_pathsstring[]

If specified, only the files in these paths will be restored (requires includes_files to be true). Paths are relative to /home/$user

Example request

{
  "includes_files": true,
  "restore_paths": [
    "public_html/wp-content/themes"
  ]
}

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "task_level": "account"
  }
}