# WordPress Manager Settings

Optional Applications / WordPress Manager Settings

## Stop WordPress site scan

 - [GET /WordPressInstanceManager/cancel_scan](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/cancel_scan.md): This function cancels a scan that you start with the WordPressInstanceManager::start_scan function.

Note:

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

## Update WordPress site admin password

 - [GET /WordPressInstanceManager/change_admin_password](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/change_admin_password.md): This function updates a WordPress® cPAddon instance's administrator password.

Note:

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

## Remove scan log after completed scan

 - [GET /WordPressInstanceManager/cleanup_scan](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/cleanup_scan.md): This function cleans up the scan log file after you complete a scan with the WordPressInstanceManager::start_scan function. To read more information about the complete scan process, read our UAPI Functions - WordPressInstanceManager::start_scan documentation.

Note:

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

## Update WordPress site automatic update settings

 - [GET /WordPressInstanceManager/configure_autoupdate](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/configure_autoupdate.md): This function configures a WordPress cPAddon instance's automatic updates settings. If you enable automatic updates for a legacy WordPress cPAddon instance, the function will convert it to use the RPM-based WordPress cPAddon.

Important:

  This function changes the instance's automatic update setting in the wp-config.php file. Before you run this function, you should verify that a filter does not exist for the automatic update settings. Use the get_instance_by_id function and view the autoupdate.core.has_filter return to determine if a filter exists.

Note:

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

## Return WordPress Manager plugin version

 - [GET /WordPressInstanceManager/get_api_version](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_api_version.md): This function retrieves the WordPress Manager plugin's version.

Note:

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

## Return WordPress site settings

 - [GET /WordPressInstanceManager/get_instance_by_id](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_instance_by_id.md): This function retrieves a WordPress® instance's configuration.

Note:

* You must install the WordPress Manager cPanel plugin to access this API function.
* This function retrieves some data that the system stored during the WordPress installation. That data may not reflect the most recent user changes.

## Return WordPress sites

 - [GET /WordPressInstanceManager/get_instances](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_instances.md): This function lists an account's WordPress® instances.

Note:

* You must install the WordPress Manager cPanel plugin to access this API function.
* This function retrieves data that the system stored during the WordPress installation. That data may not reflect the most recent user changes.

## Return latest wordpress.org updates

 - [GET /WordPressInstanceManager/get_latest_wordpress_version_from_wordpress_org](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_latest_wordpress_version_from_wordpress_org.md): This function returns the available WordPress® updates from wordpress.org.

Note:

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

## Return WordPress site scan results

 - [GET /WordPressInstanceManager/get_scan_results](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/get_scan_results.md): 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.

## Verify WordPress cPAddon availability

 - [GET /WordPressInstanceManager/is_installable_addon_available](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/is_installable_addon_available.md): This function verifies that the RPM-based WordPress® cPAddon exists on the system.

Note:

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

## Start WordPress sites scan

 - [GET /WordPressInstanceManager/start_scan](https://api.docs.cpanel.net/specifications/cpanel.openapi/wordpress-manager-settings/wordpressinstancemanager-start_scan.md): 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.

Note:

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

### Server Sent Events (SSE)

This function uses the following SSE events:

* register — 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 get_instances and UAPI get_instance_by_id functions.
* found — The scan operation found a WordPress instance. If the WordPress instance is newly
discovered, the system will also generate a register event for the instance. The data is a
JSON-encoded object containing the following:
  * path — The absolute file path to the instance.
* done — The scan is finished. The data is a JSON-encoded object that contains:
  * found — An array of strings that represents the absolute path to the discovered instances and
  any instances that the system already registered.
  * converted — An array of converted instances that the system returns in the same format
  provided in the UAPI get_instances and UAPI get_instance_by_id functions.
* terminated — The system or user terminated the scan.	
* timedout — The scan timed out before it completed.
* register-failed — The system failed to build the instance registry.	The data is a JSON-encoded
string that contains the error message.
* register-load-failed — 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.