---
title: "Run UAPI function through WHM API"
method: GET
path: "/uapi_cpanel"
tags: ["API Execution"]
---

# Run UAPI function through WHM API

`GET /uapi_cpanel`

This function calls a UAPI function through the WHM API. This function's output will match the UAPI function that it calls.

## Query parameters

- `cpanel.function` string, required
- `cpanel.module` string, required
- `cpanel.user` string, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `uapi` object — hash of function output. Each hash contains the returns from the called UAPI function. For information about a function's returns, read the function's documentation.
      - `data` union — The UAPI response. This value varies based on the UAPI function requested.
        - string
        - number
        - integer
        - boolean
        - unknown[]
          - unknown
        - object
      - `errors` string[], nullable — List of errors produced the by the API if any.
      - `messages` string[], nullable — List of messages produced the by the API if any.
      - `metadata` object
        - `transformed` 0 | 1 — - 1 - A transform was applied. - 0 - A transform was not applied.
      - `status` 0 | 1 — - 1 - Success - 0 - Failed: Check the errors field for more details.
      - `warnings` string[], nullable — List of warnings produced the by the API if any.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — - 1 - Success - 0 - Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)