Child pages
  • WHM API 1 Functions - list_database_users

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function lists the server's database users.

Warning
titleWarning:

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

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/list_database_users?api.version=1
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/list_database_users?api.version=1
Expand
titleCommand Line
Code Block
languagebash
whmapi1 list_database_users

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "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"
  }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<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>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

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