cPanel API 2 Functions - Postgres::userexists

Description

This function checks whether a PostgreSQL® database user exists.

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=userexists&user=example_user

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Check whether user "example_user" exists in PostgreSQL
$cogito_ergosum $cpanel->api2(
    'Postgres''userexists',
 array(
        'user'        => 'example_user',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Check whether user "example_user" exists in PostgreSQL
my $cogito_ergosum $cpliveapi->api2(
    'Postgres''userexists',
    {
        'user'        => 'example_user',
    }
);

 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": "userexists",
    "data": [
      {
        "userexists": "1"
      }
    ],
    "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

user

 string 

Required

 The database user. 

A valid string.

 example_user 

 

 

Returns

Return

Type

Description

Possible values

Example

 userexists 

 boolean 

Whether the database user exists.

  • 1 — User exists.
  • 0 — User does not exist.

1

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

 

  • 15 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....