Return WordPress site backups

This function retrieves a list of available WordPress® site backups of a single site.

Note:

You must install the WordPress Manager cPanel plugin to access this API function.

SecurityBasicAuth

Request

query Parameters

site

required

string

The WordPress site's URL without the protocol prefix.

Example: site=example.com/wordpress

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/WordPressBackup/get_available_backups

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  WordPressBackup \
  get_available_backups \
  site='example.com/wordpress'

Response samples

application/json

{"apiversion": 3,
"func": "get_available_backups",
"module": "WordPressBackup",
"result": {"data": {"available": [{"date": 1539267197000,
"file": "example.com__2018-10-10T10:53:31-0500.tar.gz",
"path": "/home/example/wordpress-backups/example.com__2018-10-10T10:53:31-0500.tar.gz",
"site": "example.com"
}
],
"dir": "/home/example/wordpress-backups"
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}