Child pages
  • UAPI Functions - Postgresql::delete_user
Skip to end of metadata
Go to start of metadata

Description

This function deletes a PostgreSQL® user.

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/delete_user?name=example


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.
 
// Delete the example PosgreSQL user.
$delete_user = $cpanel->uapi(
    'Postgresql', 'delete_user',
    array(
        'name'       => 'example',
    )
);


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.
 
# Delete the example PostgreSQL user user.
my $delete_user = $cpliveapi->uapi(
    'Postgresql', 'delete_user',
    {
        'name'       => 'example',
    }
);


Note:

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

 Command Line
uapi --user=username Posgresql delete_user name=example


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)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
namestring

Required

The PostgreSQL user's name.

A PostgreSQL user on the cPanel account.

example

Returns

This function only returns metadata.