---
title: "Return background task status"
method: GET
path: "/WPX/get_task_status"
tags: ["WPX"]
---

# Return background task status

`GET /WPX/get_task_status`

## Request

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

This function reports whether a queued background task is still in the
caller's task queue. It answers only that one question.

  **Note:**

  - This function and `get_task_progress` are a pair, and they are not
    interchangeable. `get_task_status` takes a `task_id`, reads the task
    queue, and reports only whether the task is still queued. It cannot
    tell you whether the work succeeded. `get_task_progress` takes an
    `install_id` parameter, reads the run's progress log, and is the authoritative
    source for progress and for success or failure. Prefer
    `get_task_progress` unless you specifically need to know whether the
    task is still queued.
  - A `task_id` parameter that is absent from the queue returns `done`. A finished
    task, a removed task, a task that never existed, and a task that
    belongs to another account are indistinguishable, and all four return
    `done`. There is no not-found failure.
  - Ownership needs no check: the queue lives in the caller's own home
    directory, so the caller can only ever see its own tasks.

## Query parameters

- `task_id` string, required

## 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 queue state of the task.
      - `message` 'running' | 'not found': A fixed, untranslated label that mirrors the `status` field. - `running` - The task is still queued. - `not found` - The task is no longer in the queue.
      - `status` 'running' | 'done': Whether the task is still queued. - `running` - The task is still in the queue. - `done` - The task is not in the queue. This does not mean the work succeeded.
    - `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_status/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)