# 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 .



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

Endpoint: GET /WordPressInstanceManager/get_scan_results
Version: 11.134.0.5
Security: BasicAuth

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "get_scan_results"

  - `module` (string)
    The name of the module called.
    Example: "WordPressInstanceManager"

  - `result` (object)

  - `result.data` (object)

  - `result.data.instances` (array)
    An array of objects that contains the WordPress instance information.

  - `result.data.instances.addon_config` (string)
    The WordPress instance's configuration file location.
    Example: "/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml"

  - `result.data.instances.addon_name` (string)
    The WordPress cPAddon that installed the instance.
* 
* 
*
    Enum: "cPanel::Blogs::WordPress", "cPanel::Blogs::WordPressX", "cPanel::Blogs::WordPressUnmanaged"

  - `result.data.instances.addon_type` (string)
    The WordPress instance's installation method.
*  — Installed by RPM-managed WordPress cPAddon.
*  — Installed by legacy cPAddon.
*  — Installed by third-party tool or the WordPress installer.
    Enum: "modern", "legacy", "unmanaged"

  - `result.data.instances.admin_url` (string)
    The URL to the instance's administration interface.
    Example: "example.com/wp-login.php"

  - `result.data.instances.admin_username` (string)
    The administrator username the installer created at the time of installation.
    Example: "admin"

  - `result.data.instances.available_version` (string)
    The latest Wordpress's version.
    Example: "4.9.5"

  - `result.data.instances.current_version` (string)
    The WordPress instance's installed version.
    Example: "4.9.5"

  - `result.data.instances.db_name` (string)
    The WordPress instance's database name.
    Example: "example_wp"

  - `result.data.instances.db_prefix` (string)
    The WordPress instance's database prefix.
    Example: "wp"

  - `result.data.instances.db_server` (string)
    The WordPress instance's database server hostname.
    Example: "localhost"

  - `result.data.instances.db_type` (string)
    The WordPress instance's database type.
* 
*
    Enum: "mysql", "postgres"

  - `result.data.instances.db_username` (string)
    The WordPress instance's database username.
    Example: "example_wp"

  - `result.data.instances.domain` (string)
    The WordPress instance's domain.
    Example: "example.com"

  - `result.data.instances.full_path` (string)
    The WordPress instance's full installation path.
    Example: "/home/example/public_html"

  - `result.data.instances.homedir` (string)
    The cPanel account's home directory.
    Example: "/home/example"

  - `result.data.instances.id` (string)
    The WordPress instance's unique identifier.
    Example: "cPanel__Blogs__WordPressX.0.1528208546"

  - `result.data.instances.initial_install_version` (string)
    The WordPress instance's version number at installation.
    Example: "4.9.6"

  - `result.data.instances.rel_path` (string)
    The WordPress instance's installation path relative to the domain's document root.
    Example: "public_html"

  - `result.data.instances.site_url` (string)
    The WordPress instance's home page URL.
    Example: "example.com"

  - `result.data.is_running` (integer)
    Whether the system detects an active scan.

*  - A scan is active.
*  - No scans are active.
    Enum: 0, 1

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.status` (integer)
    *  - Success.
*  - Failed. Check the  field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.