---
title: "Return WordPress task progress"
method: GET
path: "/WPX/get_task_progress"
tags: ["WPX"]
---

# Return WordPress task progress

`GET /WPX/get_task_progress`

## Request

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

This function returns the progress of a WordPress installation or import
for the supplied `install_id` parameter.

  **Note:**

  - Use this function to read progress with a cPanel API token. The
    equivalent Server-Sent Events stream (the `sse_url` field) is only
    available to an interactive cPanel session, not to an API token.
  - `create_website` and `import_website` return the `install_id` in
    their normal-start responses. Those are the only two functions that
    return one. `create_nova_for_wordpress_website` queues no
    installation task and returns no `install_id` value; a Nova walkthrough
    gets one when its later `import_website` callback starts the import.
  - This function is the authoritative source for progress and for
    success or failure, and it still works after the task finishes,
    because it reads the run's progress log. `get_task_status` reads the
    task queue instead, so it can only report whether the task is still
    queued, and it cannot tell success from failure.

## Query parameters

- `install_id` string, required

## 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 latest progress for the run.
      - `message` string: The most recent human-readable progress or outcome message. May be empty.
      - `percentage` integer: The install or import progress, from 0 to 100.
      - `status` 'unknown' | 'running' | 'complete' | 'failed': The run state. * `unknown` - No progress log exists yet, or the `install_id` value is not the caller's. * `running` - The run is in progress. No terminal event yet. * `complete` - The run finished successfully, or progress reached 100%. * `failed` - The run reported a terminal failure.
    - `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/get_task_progress/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)