Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function is deprecated and does not return useful output.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Note:

This function is deprecated. Instead, we recommend that you use cPanel's Images interface (Home >> Files >> Images).

Examples 


 WHM API (JSON)
This function is deprecated.

Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
This function is deprecated.

Note:

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

 

 LiveAPI Perl Module
This function is deprecated.

Note:

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

 

 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.

 Command Line
This function is deprecated.

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
This function is deprecated.

Note:

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

   

Parameters

This function is deprecated.

Returns

This function is deprecated.