v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Mysql
User Management

Return MySQL users

This function lists an account's MySQL® database users.

Important:

When you disable the MySQL/MariaDB role and remote MySQL is not configured, the system disables this function.

get/Mysql/list_users

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_users",
  "module": "Mysql",
  "result": {
    "data": [
      {
        "databases": [
          "user_database1",
          "user_database2"
        ],
        "shortuser": "user1",
        "user": "example_user1"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}