clientapi_cpanel.PostgreSQLUserManagementApi

All URIs are relative to https://cpanel-server.tld:2083/execute

Method	HTTP request	Description
create_user	GET /Postgresql/create_user	Create PostgreSQL user
grant_all_privileges	GET /Postgresql/grant_all_privileges	Enable all user privileges on PostgreSQL database
postgresql_delete_user	GET /Postgresql/delete_user	Delete PostgreSQL user
postgresql_list_users	GET /Postgresql/list_users	Return PostgreSQL users
postgresql_rename_user	GET /Postgresql/rename_user	Update PostgreSQL username
postgresql_update_privileges	GET /Postgresql/update_privileges	Update PostgreSQL® privileges
rename_user_no_password	GET /Postgresql/rename_user_no_password	Update PostgreSQL username without password
revoke_all_privileges	GET /Postgresql/revoke_all_privileges	Remove PostgreSQL user privileges
set_password	GET /Postgresql/set_password	Update PostgreSQL user password

create_user

InlineResponse200379 create_user(name, password)

Create PostgreSQL user

This function creates a PostgreSQL® database user.

Important:

When you disable the PostgreSQL role, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200379 import InlineResponse200379
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.PostgreSQLUserManagementApi(api_client)
    name = 'dbuser' # str | The database user's name.  **Note:**  If database prefixing is enabled, this parameter **must** include the database prefix for the account.
    password = '123456luggage' # str | The new user's password.

    try:
        # Create PostgreSQL user
        api_response = api_instance.create_user(name, password)
        print("The response of PostgreSQLUserManagementApi->create_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostgreSQLUserManagementApi->create_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The database user's name. Note: If database prefixing is enabled, this parameter must include the database prefix for the account.
password	str	The new user's password.

Return type

InlineResponse200379

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

grant_all_privileges

InlineResponse200383 grant_all_privileges(database, user)

Enable all user privileges on PostgreSQL database

This function grants all privileges for a PostgreSQL® database to a database user.

Important:

When you disable the PostgreSQL role, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200383 import InlineResponse200383
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.PostgreSQLUserManagementApi(api_client)
    database = 'example_database' # str | The database's name.  **Note**  If database prefixing is enabled, this value **must** include the database prefix for the account.
    user = 'example_dbuser' # str | The database user's name.  **Note**  If database prefixing is enabled, this value **must** include the database prefix for the account.

    try:
        # Enable all user privileges on PostgreSQL database
        api_response = api_instance.grant_all_privileges(database, user)
        print("The response of PostgreSQLUserManagementApi->grant_all_privileges:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostgreSQLUserManagementApi->grant_all_privileges: %s\n" % e)

Parameters

Name	Type	Description	Notes
database	str	The database's name. Note If database prefixing is enabled, this value must include the database prefix for the account.
user	str	The database user's name. Note If database prefixing is enabled, this value must include the database prefix for the account.

Return type

InlineResponse200383

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postgresql_delete_user

InlineResponse200381 postgresql_delete_user(name)

Delete PostgreSQL user

This function deletes a PostgreSQL® user.

Important:

When you disable the PostgreSQL role, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200381 import InlineResponse200381
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.PostgreSQLUserManagementApi(api_client)
    name = 'example' # str | The PostgreSQL user's name.

    try:
        # Delete PostgreSQL user
        api_response = api_instance.postgresql_delete_user(name)
        print("The response of PostgreSQLUserManagementApi->postgresql_delete_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostgreSQLUserManagementApi->postgresql_delete_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	The PostgreSQL user's name.

Return type

InlineResponse200381

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postgresql_list_users

InlineResponse200385 postgresql_list_users()

Return PostgreSQL users

This function lists an account's PostgreSQL® database users.

Important:

When you disable the PostgreSQL role, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200385 import InlineResponse200385
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.PostgreSQLUserManagementApi(api_client)

    try:
        # Return PostgreSQL users
        api_response = api_instance.postgresql_list_users()
        print("The response of PostgreSQLUserManagementApi->postgresql_list_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostgreSQLUserManagementApi->postgresql_list_users: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200385

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postgresql_rename_user

InlineResponse200387 postgresql_rename_user(newname, oldname, password)

Update PostgreSQL username

This function renames a PostgreSQL® database user.

Important:

When you disable the PostgreSQL role, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200387 import InlineResponse200387
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.PostgreSQLUserManagementApi(api_client)
    newname = 'dbuser2' # str | The database user's new name.  **Note:**  If database prefixing is enabled, this parameter **must** include the database prefix for the account.
    oldname = 'dbuser' # str | The database user's current name.  **Note:**  If database prefixing is enabled, this parameter **must** include the database prefix for the account.
    password = '123456luggage' # str | The database user's new password.

    try:
        # Update PostgreSQL username
        api_response = api_instance.postgresql_rename_user(newname, oldname, password)
        print("The response of PostgreSQLUserManagementApi->postgresql_rename_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostgreSQLUserManagementApi->postgresql_rename_user: %s\n" % e)

Parameters

Name	Type	Description
newname	str	The database user's new name. Note: If database prefixing is enabled, this parameter must include the database prefix for the account.
oldname	str	The database user's current name. Note: If database prefixing is enabled, this parameter must include the database prefix for the account.
password	str	The database user's new password.

Return type

InlineResponse200387

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postgresql_update_privileges

InlineResponse200391 postgresql_update_privileges()

Update PostgreSQL® privileges

This function synchronizes PostgreSQL® database user privileges on an account.

Some versions of PostgreSQL are ANSI SQL-92 compliant and do not support recursive grants, wildcard grants, or future grants. If you use phpPgAdmin, or manually create new tables, and you want multiple PostgreSQL users to access your PostgreSQL tables, you may either call this API function or click Synchronize Grants in the PostgreSQL Databases interface (Home >> Databases >> PostgreSQL Databases) after you add a table.

Important:

When you disable the PostgreSQL role, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200391 import InlineResponse200391
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.PostgreSQLUserManagementApi(api_client)

    try:
        # Update PostgreSQL® privileges
        api_response = api_instance.postgresql_update_privileges()
        print("The response of PostgreSQLUserManagementApi->postgresql_update_privileges:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostgreSQLUserManagementApi->postgresql_update_privileges: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200391

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

rename_user_no_password

InlineResponse200388 rename_user_no_password(newname, oldname)

Update PostgreSQL username without password

This function renames a PostgreSQL® database user.

Warning:

If you rename a PostgreSQL user, you must set the password for the database user. This is required because of the md5 hash that PostgreSQL creates to store user passwords.
We strongly recommend that you use the Postgresql::rename_user function instead of this one.

Important:

When you disable the PostgreSQL role, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200388 import InlineResponse200388
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.PostgreSQLUserManagementApi(api_client)
    newname = 'dbuser2' # str | The database user's new name.  **Note:**  If database prefixing is enabled, this parameter **must** include the database prefix for the account.
    oldname = 'dbuser' # str | The database user's current name.  **Note:**  If database prefixing is enabled, this parameter **must** include the database prefix for the account.

    try:
        # Update PostgreSQL username without password
        api_response = api_instance.rename_user_no_password(newname, oldname)
        print("The response of PostgreSQLUserManagementApi->rename_user_no_password:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostgreSQLUserManagementApi->rename_user_no_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
newname	str	The database user's new name. Note: If database prefixing is enabled, this parameter must include the database prefix for the account.
oldname	str	The database user's current name. Note: If database prefixing is enabled, this parameter must include the database prefix for the account.

Return type

InlineResponse200388

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

revoke_all_privileges

InlineResponse200389 revoke_all_privileges(database, user)

Remove PostgreSQL user privileges

This function revokes all privileges for a PostgreSQL® database from a database user.

Important:

When you disable the PostgreSQL role, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200389 import InlineResponse200389
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.PostgreSQLUserManagementApi(api_client)
    database = 'example_database' # str | The database's name.  **Note**  If database prefixing is enabled, this value **must** include the database prefix for the account.
    user = 'example_dbuser' # str | The database user's name.  **Note**  If database prefixing is enabled, this value **must** include the database prefix for the account.

    try:
        # Remove PostgreSQL user privileges
        api_response = api_instance.revoke_all_privileges(database, user)
        print("The response of PostgreSQLUserManagementApi->revoke_all_privileges:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostgreSQLUserManagementApi->revoke_all_privileges: %s\n" % e)

Parameters

Name	Type	Description	Notes
database	str	The database's name. Note If database prefixing is enabled, this value must include the database prefix for the account.
user	str	The database user's name. Note If database prefixing is enabled, this value must include the database prefix for the account.

Return type

InlineResponse200389

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_password

InlineResponse200390 set_password(password, user)

Update PostgreSQL user password

This function changes a PostgreSQL® database user's password.

Important:

When you disable the Postgres role, the system disables this function.

Example

Basic Authentication (BasicAuth):

import clientapi_cpanel
from clientapi_cpanel.models.inline_response200390 import InlineResponse200390
from clientapi_cpanel.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cpanel-server.tld:2083/execute
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_cpanel.Configuration(
    host = "https://cpanel-server.tld:2083/execute"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_cpanel.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with clientapi_cpanel.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_cpanel.PostgreSQLUserManagementApi(api_client)
    password = '12345luggage' # str | The user's new password.
    user = 'dbuser' # str | The database user's name.  **Note:**  If database prefixing is enabled, this parameter **must** include the database prefix for the account.

    try:
        # Update PostgreSQL user password
        api_response = api_instance.set_password(password, user)
        print("The response of PostgreSQLUserManagementApi->set_password:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostgreSQLUserManagementApi->set_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
password	str	The user's new password.
user	str	The database user's name. Note: If database prefixing is enabled, this parameter must include the database prefix for the account.

Return type

InlineResponse200390

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	HTTP Request was successful.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

PostgreSQLUserManagementApi.md

Latest commit

History

PostgreSQLUserManagementApi.md

File metadata and controls

clientapi_cpanel.PostgreSQLUserManagementApi

create_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

grant_all_privileges

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postgresql_delete_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postgresql_list_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postgresql_rename_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postgresql_update_privileges

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

rename_user_no_password

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

revoke_all_privileges

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_password

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details