We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - ImageManager::convert_file
Skip to end of metadata
Go to start of metadata

Description

This function converts an image to a new file format.

Important:

In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/ImageManager/convert_file?image_file=images/myimage.jpg&type=png


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.
 
// Convert the image to png format.
$convert_image = $cpanel->uapi(
    'ImageManager', 'convert_file',
    array(
        'image_file'    => 'images/myimage.jpg',
        'type'   => 'png',
    )
);


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.
 
# Convert the image to png format.
my $convert_image = $cpliveapi->uapi(
    'ImageManager', 'convert_file',
    {
        'image_file'    => 'images/myimage.jpg',
        'type'   => 'png',
    }
);


Note:

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

 Command Line
uapi --user=username ImageManager convert_file image_file=images/myimage.jpg type=png


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)
	{
          "status" : 1,
          "messages" : null,
          "errors" : null,
          "warnings" : null,
          "metadata" : {},
          "data" : {
             "converted_file" : "/home/cptest1/images/myimage.gif"
          }
       }


Note:

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

Parameters 

ParameterTypeDescriptionPossible valuesExample
image_filestring

Required

The image file to convert.

A filepath, relative to the cPanel account's home directory.images/myimage.jpg
typestring

Required

The format to which to convert the images.

A valid image format (for example, png or jpg).png

Returns

ReturnTypeDescriptionPossible valuesExample
converted_file stringThe new filepath to the image.A valid, absolute filepath./home/cptest1/images/myimage.png