---
title: "Return MySQL users"
method: GET
path: "/list_database_users"
tags: ["Databases", "MySQL Databases"]
---

# Return MySQL users

`GET /list_database_users`

This function lists the server's database users.

**Warning:**

On most servers, this function returns a large amount of output. We **strongly** suggest that you filter and sort the output.

**Important:**

  When you disable the [MySQL/MariaDB and PostgreSQL roles](https://go.cpanel.net/serverroles) and remote MySQL is not already configured, the system **disables** this function.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `payload` object[] — An array of database data objects.
      - `cpuser` string — The database user's owner.
      - `engine` 'mysql' | 'postgresql' — The database user's database engine. * `mysql` * `postgresql`
      - `name` string — The database user's name.
  - `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)