Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - Postgresql::list_databases - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - Postgresql::list_databases
Skip to end of metadata
Go to start of metadata

Description

This function lists an account's PostgreSQL® databases.

Important:

When you disable the Postgres role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Postgresql/list_databases


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the databases on the account.
$list_databases = $cpanel->uapi(
    'Postgresql', 'list_databases'
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List the databases on the account.
my $list_databases = $cpliveapi->uapi(
    'Postgresql', 'list_databases'
);


Note:

For more information, read our Guide to the LiveAPI System.

 Command Line
uapi --user=username Postgresql list_databases


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "errors":null,
   "metadata":{  
      "transformed":1
   },
   "warnings":null,
   "status":1,
   "messages":null,
   "data":[  
      {  
         "users":[  

         ],
         "disk_usage":673 , 
         "database":"user_db"
      },
      {  
         "disk_usage"0,
         "database":"user_db2",
         "users":[  
            "db2_user"
         ]
      },
     }
   ]
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return TypeDescriptionPossible valuesExample

database

string

The database name.

A valid database name.user_db

disk_usage

integer

The disk space that the database uses, in bytes.

An integer value.673

users

array

An array of database usernames.

A valid database username.

Note:

If no users exist on a database, the function returns an empty array

db_user