# Start WordPress sites scan

This function scans for WordPress® instances installed on a cPanel account. The system will populate cPanel's WordPress Manager interface with any newly discovered instances.



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

### Server Sent Events (SSE)

This function uses the following SSE events:

*  — The scan operation discovered a WordPress instance and registered it. The data is a
JSON-encoded object containing the attributes of the instance, with the same format used in the
UAPI  and UAPI  functions.
*  — The scan operation found a WordPress instance. If the WordPress instance is newly
discovered, the system will also generate a  event for the instance. The data is a
JSON-encoded object containing the following:
  *  — The absolute file path to the instance.
*  — The scan is finished. The data is a JSON-encoded object that contains:
  *  — An array of strings that represents the absolute path to the discovered instances and
  any instances that the system already registered.
  *  — An array of converted instances that the system returns in the same format
  provided in the UAPI  and UAPI  functions.
*  — The system or user terminated the scan.	
*  — The scan timed out before it completed.
*  — The system failed to build the instance registry.	The data is a JSON-encoded
string that contains the error message.
*  — The system could not load the registry after building the instance
registry. The data is a JSON-encoded string that contains the error message.

For more information about server sent events, read Mozilla's Using server-sent events documentation.

Endpoint: GET /WordPressInstanceManager/start_scan
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: "start_scan"

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

  - `result` (object)

  - `result.data` (object)

  - `result.data.guid` (string)
    The unique identifier for the scan. A valid string.
    Example: "B3A27B96-51F7-11E8-92E3-CC90C4F823F0"

  - `result.data.log` (string)
    The absolute path to the log file for the scan.
    Example: "/home/example/.cpanel/plugins/wordpress/scans/B3A27B96-51F7-11E8-92E3-CC90C4F823F0"

  - `result.data.sse_url` (string)
    The SSE interface that other applications can use to track the progress of the scan.



For more information about the SSE interface, read the [Server Sent Events](#server-sent-events-sse) section.
    Example: "/sse/WordPressScan/B3A27B96-51F7-11E8-92E3-CC90C4F823F0"

  - `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 errors 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.