Return WordPress site backup status

This function checks for an active WordPress® site backup.

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 http://.

Example: site=example.com 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/is_running
Request samples
uapi --output=jsonpretty \
  --user=username \
  WordPressBackup \
  is_running \
  site='example.com

example.com/wordpress'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "is_running",
  • "module": "WordPressBackup",
  • "result": {
    • "data": {
      • "action_id": "example.com__2018-10-10T10:53:31-0500",
      • "is_running": 0
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}