Return WordPress site scan results

This function checks the status of a completed scan and reports the results. To find more information about the scan process, read our UAPI documentation for WordPressInstanceManager::start_scan.

Note:

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

SecurityBasicAuth
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/WordPressInstanceManager/get_scan_results
Request samples
uapi --output=jsonpretty \
  --user=username \
  WordPressInstanceManager \
  get_scan_results
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "get_scan_results",
  • "module": "WordPressInstanceManager",
  • "result": {
    • "data": {
      • "instances": [
        • {
          • "addon_config": "/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml",
          • "addon_name": "cPanel::Blogs::WordPressX",
          • "addon_type": "modern",
          • "admin_url": "example.com/wp-login.php",
          • "admin_username": "admin",
          • "available_version": "4.9.5",
          • "current_version": "4.9.5",
          • "db_name": "example_wp",
          • "db_prefix": "wp",
          • "db_server": "localhost",
          • "db_type": "mysql",
          • "db_username": "example_wp",
          • "domain": "example.com",
          • "full_path": "/home/example/public_html",
          • "homedir": "/home/example",
          • "id": "cPanel__Blogs__WordPressX.0.1528208546",
          • "initial_install_version": "4.9.6",
          • "rel_path": "public_html",
          • "site_url": "example.com"
          }
        ],
      • "is_running": 1
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}