Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists the server's databases.

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_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:

  • 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. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 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

ReturnTypeDescriptionPossible valuesExample
payloadarray of hashesAn 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