cPanel API 2 Functions - Postgres::listusersindb

Description

This function lists the users with access to a PostgreSQL® database.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

 

Examples 


 WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Postgres&cpanel_jsonapi_func=listusersindb&db=example_database

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Generate a list of Postgres database users with access to "example_database"
$list_pgusers $cpanel->api2(
    'Postgres''listusersindb',
 array(
        'db'        => 'example_database',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Generate a list of Postgres database users with access to "example_database"
my $list_pgusers $cpliveapi->api2(
    'Postgres''listusersindb',
 {
        'db'        => 'example_database',
    }
);

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listusersindb",
    "data": [
      {
        "db": "example_database",
        "user": "example_pgdbuser1"
      },
      {
        "db": "example_database2",
        "user": "example_pgdbuser2"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Postgres"
  }
}

 

Note:

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

 

Parameters

 Parameter 

 Type 

Description

 Possible values 

Example

db

 string 

The database name.

Note:

 If you do not include this parameter, the function will return results for all databases. 

A valid string.

 example_database 

 

 

Returns

 Return 

Type

Description

Possible values

Example

db

string

The database name.

A valid string.

example_database

user

string

The database username.

A valid string.

example_pgdbuser1

reason

string

A reason for failure.

Note:

 This function only returns a reason value if it failed. 

A string that describes the error.

 This is an error message. 

result

 boolean 

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.

1

 

  • 6 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....