v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
WordPressBackup
WordPress Manager Backups

Backup WordPress site

This function starts a single WordPress® site backup.

Note:

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

get/WordPressBackup/start

Query parameters

string url-path required
OR
string domain 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": "start",
  "module": "WordPressBackup",
  "result": {
    "data": {
      "backup_id": "example.com__2018-10-10T10:53:31-0500",
      "site": "example.com",
      "sse_url": "/sse/WordPressBackup"
    },
    "status": 1
  }
}