You can find our user documentation at

Check out our new API beta site!

Child pages
  • cPanel API 2 Functions - Branding::gensprites
Skip to end of metadata
Go to start of metadata



This function rebuilds the cPanel interface's sprites. Sprites store the cPanel interface's icons as a single image to conserve bandwidth.

When you upload an icon, the system generates sprites automatically. You may need to generate sprites manually if your changes do not display correctly.


cPanel API 2's Branding module only modifies data for the x3 theme. To customize the Paper Lantern theme, use UAPI functions. For more information, read our Guide to cPanel Interface Customization and Branding documentation.


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



 WHM API (JSON)"snap_to_smallest_width"&subtype="img"&format="jpg"


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

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// Generate sprite files.
$generate_sprites = $cpanel->api2(
    'Branding', 'gensprites',
            'method'      => 'snap_to_smallest_width',
            'subtype'     => 'img',
            'format'      => 'jpg',


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.
# Generate sprite files.
my $generate_sprites = $cpliveapi->api2(
    'Branding', 'gensprites',
            'method'      => 'snap_to_smallest_width',
            'subtype'     => 'img',
            'format'      => 'jpg',


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


 cPanel Tag System (deprecated)


  • 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. 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
cpapi2 --user=username Branding gensprites method=snap_to_smallest_width subtype=img format=jpg


  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:


 Output (JSON)
  "cpanelresult": {
    "apiversion": 2,
    "func": "gensprites",
    "data": [
        "count": ""
    "event": {
      "result": 1
    "module": "Branding"


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



InputTypeDescriptionPossible valuesExample


The method to use to generate sprites.

  • only_filetype_gif — Generate sprites for .gif images only.
  • skip_filetype_gif — Generate sprites for all images except for .gif images.
  • snap_to_smallest_width — Scale icons to the smallest possible width.
  • scale_60percent — Scale icons to 60% of their size.



The sprite type to generate.

This parameter defaults to img.

  • img
  • bg
  • compleximg

The image format.

This parameter defaults to jpg.

A valid image type.jpg

The level of compression to use.

This parameter defaults to 100.

An integer value that represents the amount of compression to use.100
imgtypestringThe image type.

If you use this parameter, you must supply a value of icon.

The x3 theme does not support group images.




ReturnTypeDescriptionPossible valuesExample

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.