Return WordPress sites

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.
Authorizations:

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  WordPressInstanceManager \
  get_instances

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_instances",
  • "module": "WordPressInstanceManager",
  • "result": {
    • "data": {
      • "errors": [
        • "string"
        ],
      • "instances": [
        • {
          • "addon_config": "/home/example/.cpaddons/cPanel::Blogs::WordPressX.0.yaml",
          • "addon_name": "cPanel::Blogs::WordPressX",
          • "addon_type": "modern",
          • "admin_url": "example.com/wp-login.php",
          • "admin_username": "admin",
          • "available_version": null,
          • "created_on": 1528208546,
          • "current_version": null,
          • "db_name": "example_wp",
          • "db_prefix": "wp",
          • "db_server": "localhost",
          • "db_type": "mysql",
          • "db_username": "example_wp",
          • "domain": "example.com",
          • "full_path": "/home/example/public_html",
          • "homedir": "/home/example",
          • "id": "cPanel__Blogs__WordPressX.0.1528208546",
          • "import_guid": "8AF1767E-68CD-11E8-90D1-96B06D626D05",
          • "imported_on": 1528209264,
          • "initial_install_version": "4.9.6",
          • "migrated_from": "cPanel::Blogs::WordPress",
          • "migrated_on": 1528209264,
          • "recent": 1,
          • "rel_path": " ",
          • "site_url": "example.com"
          }
        ]
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}