# Return WordPress site settings

This function retrieves a WordPress® instance's configuration.



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

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

## Query parameters:

  - `id` (string, required)
    The WordPress instance's unique ID.



 You can retrieve an instance ID with the  function.
    Example: "cPanel__Blogs__WordPressX.0.1528208546"

## Response 200 fields (application/json):

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

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

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

  - `result` (object)

  - `result.data` (object)

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

  - `result.data.addon_name` (string)
    The WordPress cPAddon used to install the instance.
* 
* 
*
    Enum: "cPanel::Blogs::WordPress", "cPanel::Blogs::WordPressX", "cPanel::Blogs::WordPressUnmanaged"

  - `result.data.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.admin_url` (string)
    The URL to the instance's administration interface.
    Example: "example.com/wp-login.php"

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

  - `result.data.admins` (array)
    A list of the WordPress instance's administrators.

  - `result.data.admins.ID` (integer)
    The user's automatically generated identifier.
    Example: 1

  - `result.data.admins.display_name` (string)
    The user's display name.
    Example: "admin"

  - `result.data.admins.user_email` (string)
    The user's email address.
    Example: "admin@example.com"

  - `result.data.admins.user_login` (string)
    The user's login name.
    Example: "admin"

  - `result.data.admins.user_nicename` (string)
    The user's simplified username, which you can use as an HTML ID or similar.
    Example: "admin"

  - `result.data.admins.user_status` (integer)
    The user's verified status.
*  — Verified.
*  — Unverified.
    Enum: 0, 1

  - `result.data.autoupdate` (boolean)
    Whether the user enabled automatic updates.
*  — Enabled.
*  — Disabled.
    Example: true

  - `result.data.autoupdate.core.has_filter` (boolean)
    Whether one of more filters modify the core autoupdate settings.
*  — Filter(s) applied.
*  — No filters applied.



Typically, plugins apply filters to the autoupdate settings.

  - `result.data.autoupdate.core.major` (boolean)
    Whether the user enabled automatic updates for major releases.
*  — Enabled.
*  — Disabled.

  - `result.data.autoupdate.core.minor` (boolean)
    Whether the user enabled automatic updates for minor releases.
*  — Enabled.
*  — Disabled.
    Example: true

  - `result.data.available_version` (string)
    The lastest WordPress instance's version.
    Example: "4.9.6"

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

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

  - `result.data.db_name` (string)
    A database name.
    Example: "example_wp2"

  - `result.data.db_prefix` (string)
    A database table prefix.
    Example: "wp"

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

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

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

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

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

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

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

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

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

  - `result.data.rel_path` (string)
    The WordPress instance's installation path, relative to the damin's document root.



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

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

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