v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
ImageManager
Image Tools

Create image with new format

This function converts an image to a new file format.

Important:

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

get/ImageManager/convert_file

Query parameters

image_filestring required
Example:images/myimage.jpg

The image file to convert, relative to the cPanel account's /home directory.

typestring required
Example:png

The format to which to convert the images.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "convert_file",
  "module": "ImageManager",
  "result": {
    "data": {
      "converted_file": "/home/cptest1/images/myimage.png"
    },
    "status": 1
  }
}