The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
This function is for internal use only.
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
WHM API (JSON)
This function is for internal use only.For more information, read our Calls from the WHM API documentation.
LiveAPI PHP Class
This function is for internal use only.For more information, read our Guide to the LiveAPI System.
LiveAPI Perl Module
This function is for internal use only.For more information, read our Guide to the LiveAPI System.
cPanel Tag System (deprecated)
- cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI 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.
- 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 documentation.
Command Line
This function is for internal use only.You must URI-encode values.
usernamerepresents your account-level username.You must include the
--user=usernameoption.For more information and additional output options, read our Guide to cPanel API 2 documentation or run the
cpapi2 --helpcommand.If you run CloudLinux™, you must use the full path of the
cpapi2command:syntaxhighlighter-pre/usr/local/cpanel/bin/cpapi2
Output (JSON)
This function is for internal use only.Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.
This function is for internal use only.
This function is for internal use only.