# Return WordPress sites

This function lists an account's WordPress® instances.



* You  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.

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

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

  - `result` (object)

  - `result.data` (object)

  - `result.data.errors` (array)
    This array contains the errors that the system experienced while it retrieved the instances.

  - `result.data.instances` (array)
    This array of objects 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,null)
    This return is unused.

  - `result.data.instances.created_on` (integer)
    The WordPress instance's installation date.
    Example: 1528208546

  - `result.data.instances.current_version` (string,null)
    This return is unused.

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


 is the only possible value.
    Enum: "mysql"

  - `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.import_guid` (string)
    The imported WordPress instance's unique identifier.
    Example: "8AF1767E-68CD-11E8-90D1-96B06D626D05"

  - `result.data.instances.imported_on` (integer)
    The WordPress instance's import date.
    Example: 1528209264

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

  - `result.data.instances.migrated_from` (string)
    The cPAddon that the system migrated the instance from.
    Example: "cPanel::Blogs::WordPress"

  - `result.data.instances.migrated_on` (integer)
    The timestamp when the system migrated the instance from legacy to modern WordPress cPAddon.
    Example: 1528209264

  - `result.data.instances.recent` (integer)
    Whether the system added the WordPress instance in the last 24 hours.
*  — Added recently.
*  — Added previously.
    Enum: 0, 1

  - `result.data.instances.rel_path` (string)
    The WordPress instance's installation path.


This function returns an empty value if the relative path is the document root.
    Example: " "

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

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