Child pages
  • WHM API 1 Functions - list_databases

Versions Compared

Key

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

Description

Excerpt

This function lists the server's databases.


Warning
titleWarning:

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

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledMySQLPostgresRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


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



Expand
titleXML API


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



Expand
titleCommand Line


Code Block
languagebash
whmapi1 list_databases

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "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"
  }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<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>


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