---
title: "Return WordPress installations"
method: GET
path: "/WPX/list_websites"
tags: ["WPX"]
---

# Return WordPress installations

`GET /WPX/list_websites`

## Request

- Base URL: `https://cpanel-server.tld:2083/execute`
- URL: `https://cpanel-server.tld:2083/execute/WPX/list_websites`
- Auth: HTTP basic

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.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer: The version of the API.
  - `func` string: The name of the method called.
  - `module` string: The name of the module called.
  - `result` object
    - `data` object: The installations and summary counts.
      - `domains` object[]: The caller's WordPress installations.
        - `admin_url` string: The WordPress administrator login URL.
        - `alive` 1 | 0: Whether the installation is responding.
        - `broken` 1 | 0: Whether WordPress Toolkit reports the installation as broken.
        - `documentroot` string: The filesystem path to the WordPress root.
        - `domain` string: The normalized bare hostname of the site.
        - `infected` 1 | 0: Whether WordPress Toolkit reports the installation as infected.
        - `outdated_php` 1 | 0: Whether the installation runs an outdated PHP version.
        - `outdated_wp` 1 | 0: Whether the installation runs an outdated WordPress version.
        - `title` string: The WordPress site title. May be empty.
        - `unsupported_php` 1 | 0: Whether the installation runs an unsupported PHP version.
        - `unsupported_wp` 1 | 0: Whether the installation runs an unsupported WordPress version.
        - `url` string: The public site URL.
        - `version` string: The WordPress version. May be empty if unknown.
        - `wptk_id` integer, nullable: The WordPress Toolkit instance id. This is `null` when the upstream record carries no id. Guard against that before you send the value to a function that takes an `id` parameter, because WordPress Toolkit ids are positive integers and there is no valid `0`.
      - `info` object: Summary counts for the result set.
        - `disk_quota_reached` 1 | 0: Whether the account has reached the disk quota that blocks a new install.
        - `results` integer: The number of installations returned.
        - `total` integer: The total number of installations.
    - `errors` string[], nullable: List of errors if the API failed.
    - `messages` string[], nullable: List of messages generated by the API.
    - `metadata` object
      - `transformed` 1: Post-processing may have transformed the data.
    - `status` 1 | 0: - `1` - Success. - `0` - Failed: Check the errors field for more details.
    - `warnings` string[], nullable: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.

## Changes

- **2026-09-23** `aed66b1a51cc`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cpanel/apis/cpanel-uapi/changes/WPX/list_websites/get.md)

---

[API](https://skmtc.dev/cpanel/apis/cpanel-uapi.md) - [All operations](https://skmtc.dev/cpanel/apis/cpanel-uapi/llms.txt) - [OpenAPI document](https://skmtc.dev/cpanel/apis/cpanel-uapi/revisions/05239220da37?raw)