Return WordPress site restore status

This function returns whether a WordPress® site backup restoration is in progress.

Note:

  • You must install the WordPress Manager cPanel plugin to access this API function.
  • The output of this function changes, depending on the state of the backup restoration.
Authorizations:

Responses

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

Request samples

uapi --user=username WordPressRestore any_running

Response samples

Content type
application/json
Example
{
  • "data": {
    • "any_running": 1,
    • "sites": [
      • {
        • "id": null,
        • "site": "example.com",
        • "type": "restore"
        }
      ]
    },
  • "errors": null,
  • "messages": null,
  • "metadata": { },
  • "status": 1,
  • "warnings": null
}