WHM API 1 Functions - list_databases

In cPanel & WHM version 76 and later, when you disable the MySQL and Postgres roles, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples

JSON API

https://hostname.example.com:2087/cpsess##########/json-api/list_databases?api.version=1

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/list_databases?api.version=1

Command Line

whmapi1 list_databases

Notes:

Unless otherwise noted, 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.
If you run CloudLinux™, you must use the full path of the whmapi1 command:
```
/usr/local/cpanel/bin/whmapi1
```

Output (JSON)

{
  "data": {
    "payload": [
      {
        "engine": "postgresql",
        "name": "example_db0",
        "cpuser": "example"
      },
      {
        "engine": "postgresql",
        "name": "example_db1",
        "cpuser": "example"
      },
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "list_databases"
  }
}

Output (XML)

<result>
    <data>
        <payload>
            <engine>postgresql</engine>
            <name>example_db0</name>
            <cpuser>example</cpuser>
        </payload>
        <payload>
            <engine>postgresql</engine>
            <name>example_db1</name>
            <cpuser>example</cpuser>
        </payload>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>list_databases</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

Return	Type	Description	Possible values	Example
`payload`	array of hashes	An array of hashes of database data.	This hash includes the `engine`, `name`, and `cpuser` returns.
`engine`	string	The database's engine. The function returns this value in the `payload` hash.	`mysql` `postgresql`	`postgresql`
`name`	string	The database's name. The function returns this value in the `payload` hash.	A valid database name.	`example_db0`
`cpuser`	string	The database's owner. The function returns this value in the `payload` hash.	A valid username.	`example`

Function information

API Version:

WHM API 1

Available in:

WHM 11.44+

Methods:

GET, POST

Required Parameters:

(none)

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Sections - Databases — Database functions allow you to manage your MySQL® and PostgreSQL® database settings.
Page:

WHM API 1 Functions - rename_mysql_database — This function changes a MySQL® database's name.
Page:

WHM API 1 Functions - rename_mysql_user — This function changes a MySQL® database user's name.
Page:

WHM API 1 Functions - set_mysql_password — This function changes a MySQL® database user's password.
Page:

WHM API 1 Functions - installable_mysql_versions — This function lists all available versions of MySQL® and MariaDB.

Child pages