v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

WordPressBackup

WordPress Manager Backups

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.

get/WordPressBackup/get_available_backups

Query parameters

sitestring required

Example:example.com/wordpress

The WordPress site's URL without the protocol prefix.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "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"
    },
    "status": 1
  }
}