---
title: "Return active WordPress installs"
method: GET
path: "/WPX/list_active_installs"
tags: ["WPX"]
---

# Return active WordPress installs

`GET /WPX/list_active_installs`

## Request

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

This function lists the WordPress installs that are still queued or
running for the account. It joins each queued install task to the run's
progress log, so `status` is the value `get_task_progress` reports.

  **Note:**

  * This function reads the task queue without taking element locks, so
    it never fails or blocks when another reader or the task runner
    briefly holds an element.
  * A task that is queued but has not written a log line yet reports
    `unknown` with a `percentage` of `0`.
  * An element in the queue is not proof that an install is in flight. If
    the task runner dies mid-install (reboot, OOM kill) the element stays
    in the queue until the account queues another task. The function
    reports such a row as `stale` when its log says `running` but the
    runner's pid file names a process that is gone or is not a task
    runner.
  * A finished install leaves the queue when the runner completes it. It
    can appear once with `complete` or `failed` in the short window
    before that removal.
  * The rows need no ownership check: the queue and the logs live in
    the caller's own home directory, so the caller can only ever see
    its own installs.

## Query parameters

- `domain` string

## Response `200`

The 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 WordPress installs that are still queued or running for the account, one row per install.
      - `domain` string: The domain the install targets, lower-cased.
      - `install_id` string: The run's correlator. Poll `get_task_progress` with it.
      - `message` string: The last progress message from the run's log. Empty when the run has not written a log line yet.
      - `percentage` integer: The monotonic progress percentage from the run's log. `0` when the run has not written a log line yet.
      - `sse_url` string: The `/sse/UserTasks/` stream for the run.
      - `status` 'unknown' | 'running' | 'stale' | 'complete' | 'failed': The run's state, as `get_task_progress` reports it. * `unknown` - The task is queued but has not written a log line yet. * `running` - The install is in progress. * `stale` - The log says the install is running but its task runner is no longer alive. The install will not finish; treat it like `failed` and offer a retry. * `complete` - The install finished. The task is about to leave the queue. * `failed` - The install failed. The task is about to leave the queue.
      - `task_id` string: The queue element id, as `create_website` returned it.
    - `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-11-04** `05239220da37`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cpanel/apis/cpanel-uapi/changes/WPX/list_active_installs/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)