Child pages
  • WHM API 1 Functions - list_database_users
Skip to end of metadata
Go to start of metadata

 

Description

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. 

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/list_database_users?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/list_database_users?api.version=1
 Command Line
whmapi1 list_database_users


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 

 Output (JSON)
{
  "data": {
    "payload": [
      {
        "cpuser": "example"
        "engine": "postgresql",
        "name": "example_user1",
      },
      {
        "cpuser": "example"
        "engine": "postgresql",
        "name": "example_user2",
      },
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "list_database_users"
  }
}
 Output (XML)
<result>
    <data>
        <payload>
            <engine>postgresql</engine>
            <name>example_user1</name>
            <cpuser>example</cpuser>
        </payload>
        <payload>
            <engine>postgresql</engine>
            <name>example_user2</name>
            <cpuser>example</cpuser>
        </payload>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>list_database_users</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
payloadarray of hashesAn array of hashes of database data.This array includes the engine, name and cpuser returns. 

engine

string

The database user's database engine.

The function returns this value in the payload array.

  • mysql
  • postgresql
postgresql

name

string

The database user's name.

The function returns this value in the payload array.

A valid database name.example_user1

cpuser

string

The database user's owner.

The function returns this value in the payload array.

A valid username.example