cPanel API 2 Functions - MysqlFE::dbuserexists - Knowledgebase

Description

This function checks whether a 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=MysqlFE&cpanel_jsonapi_func=dbuserexists&dbuser=example_user1

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Checks whether the database user "example_user1" exists
$check_user = $cpanel->api2(
    'MysqlFE', 'dbuserexists', 
    array(
        'dbuser' => 'example_user1',
 ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Checks whether the database user "example_user1" exists
my $check_user = $cpliveapi->api2(
    'MysqlFE', 'dbuserexists',
    {
        'dbuser' => 'example_user1',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI 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 our Deprecated 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,
    "data": [
      1
    ],
    "func": "dbuserexists",
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
dbuser	string	Required The database username.	A valid username.	example_user1

Parameter

Type

Description

Possible values

Example

dbuser

string

Required

The database username.

A valid username.

example_user1

Returns

Return	Type	Description	Possible values	Example
data	boolean	Whether the database user exists.	1 — The username exists. 0 — The username does not exist.	1
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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

Knowledgebase

Categories

Categories