CPcpanel
WPX

Return WordPress installations

Changed on

This function returns the caller's WordPress installations. Each row is identical in shape to the get_website response data, so the same consumer mapping works for both.

Note:

  • Ownership is enforced by filesystem path: only installations under the caller's home directory are returned.
  • Each row carries the installation's health as flat flags (alive, broken, infected, outdated_php, outdated_wp, unsupported_php, unsupported_wp), taken directly from WordPress Toolkit.
get/WPX/list_websites

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_websites",
  "module": "WPX",
  "result": {
    "data": {
      "domains": [
        {
          "admin_url": "https://blog.example.com/wp-login.php",
          "alive": 1,
          "documentroot": "/home/user/public_html",
          "domain": "blog.example.com",
          "title": "My Blog",
          "url": "https://blog.example.com",
          "version": "6.4.2",
          "wptk_id": 17
        }
      ],
      "info": {
        "results": 3,
        "total": 3
      }
    },
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}

Changes