# cPanel API 2 Functions - MysqlFE::revokedbuserprivileges Warning: The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2. ## Description This function revokes a user's privileges from a database. Warning: We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function: - [`Mysql::revoke_access_to_database`](https://api.docs.cpanel.net/openapi/cpanel/operation/revoke_access_to_database/) — This function revokes a MySQL® database user's privileges. Important: When you disable the [*MySQL/MariaDB* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles) **and** remote MySQL is **not** already configured, the system **disables** this function. ## Examples ### WHM API (JSON) ```undefined syntaxhighlighter-pre https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=MysqlFE&cpanel_jsonapi_func=revokedbuserprivileges&db=example_db1&dbuser=example_user1 ``` Note: For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation. ### LiveAPI PHP Class ```undefined syntaxhighlighter-pre $cpanel = new CPANEL(); // Connect to cPanel - only do this once. // Revoke permissions for "example_user1" on "example_db1" $revoke_user = $cpanel->api2( 'MysqlFE', 'revokedbuserprivileges', array( 'db' => 'example_db1', 'dbuser' => 'example_user1', ) ); ``` Note: For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). ### LiveAPI Perl Module ```undefined syntaxhighlighter-pre my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once. # Revoke permissions for "example_user1" on "example_db1" my $revoke_user = $cpliveapi->api2( 'MysqlFE', 'revokedbuserprivileges', { 'db' => 'example_db1', 'dbuser' => 'example_user1', } ); ``` Note: For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system). ### cPanel Tag System (deprecated) Warnings: - cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system). - cPanel API 2 calls that use cPanel tags vary in code syntax and in their output. - For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation. ### Command Line ```undefined syntaxhighlighter-pre cpapi2 --user=username MysqlFE revokedbuserprivileges db=example_db1 dbuser=example_user1 ``` div Notes: - You **must** URI-encode values. - `username` represents your account-level username. - If you run this command as the `root` user, you **must** include the `--user=username` option. - For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command. - If you run CloudLinux™, you **must** use the full path of the `cpapi2` command: ```undefined syntaxhighlighter-pre /usr/local/cpanel/bin/cpapi2 ``` br ### Output (JSON) ```undefined syntaxhighlighter-pre { "cpanelresult": { "apiversion": 2, "data": [ 1 ], "func": "revokedbuserprivileges", "event": { "result": 1 }, "module": "MysqlFE" } } ``` Note: Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls. ## Parameters table thead tr th strong Parameter th strong Type th strong Description th strong Possible values th strong Example tbody tr td code db td em string td The database name. td A valid database name. td code example_db1 tr td code dbuser td em string td The database username. td A valid database username td code example_user1 ## Returns table thead tr th strong Return th Type th Description th Possible values th Example tbody tr td code reason td em string td p A reason for failure. p This function only returns a code reason value if it failed. td p A string that describes the error. td code This is an error message. tr td code result td em Boolean td p Whether the function succeeded. td ul li code 1 — The function succeeded. li code 0 — The function failed. td code 1