Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Backups

Create a new cloud backup

Create a new cloud backup of the users' files and/or database for a given site (staging sites will only backup the staging webroot) - Via A Task

post/v1/sites/{id}/cloud_backups

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Request body

labelstring required

Label / Name of the backup

includes_filesboolean

If the backup should include all files from the site

includes_databaseboolean

If the backup should include the database

exclude_pathsstring[]

Paths to exclude from the backup

Example request

{
  "label": "April 3rd Backup - Before Plugin Updates",
  "includes_files": true,
  "exclude_paths": [
    "/home/user/public_html/wp-content/uploads"
  ]
}

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "backup_id": "8d8ac610-566d-4ef0-9c22-186b2a5ed793",
    "task_id": "60f248b2-5fd3-482a-bf40-845d2e0c909a",
    "task_level": "SITE"
  }
}