# cPanel API 2 Functions - Branding::gensprites

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

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.

div
Note:

cPanel API 2's `Branding` module **only** modifies data for the x3 theme. We removed the x3 theme. For more information, read our cPanel Deprecation Plan documentation.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Branding&cpanel_jsonapi_func=gensprites&method="snap_to_smallest_width"&subtype="img"&format="jpg"
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Generate sprite files.
$generate_sprites = $cpanel->api2(
    'Branding', 'gensprites',
        array(       
            'method'      => 'snap_to_smallest_width',
            'subtype'     => 'img',
            'format'      => 'jpg',
    )
 );
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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',
    }
 );
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Branding gensprites method=snap_to_smallest_width subtype=img format=jpg
```

div
Notes:

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

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "gensprites",
    "data": [
      {
        "count": ""
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}
```

div
Note:

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

## Parameters

table
colgroup
col
col
col
col
col
thead
tr
th
Input
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
method
td
em
string
td
p
strong
Required
p
The method to use to generate sprites.
td
ul
li
code
only_filetype_gif
 — Generate sprites for 
code
.gif
 images only.
li
code
skip_filetype_gif
 — Generate sprites for all images except for 
code
.gif
 images.
li
code
snap_to_smallest_width
 — Scale icons to the smallest possible width.
li
code
scale_60percent
 — Scale icons to 60% of their size.
td
p
code
only_filetype_gif
tr
td
code
subtype
td
em
string
td
p
The sprite type to generate.
p
This parameter defaults to 
code
img
.
td
ul
li
code
img
li
code
bg
li
code
compleximg
td
code
img
tr
td
code
format
td
em
string
td
p
The image format.
p
This parameter defaults to 
code
jpg
.
td
A valid image type.
td
code
jpg
tr
td
code
compression
td
em
integer
td
p
The level of compression to use.
p
This parameter defaults to 
code
100
.
td
An integer value that represents the amount of compression to use.
td
code
100
tr
td
code
imgtype
td
em
string
td
The image type.
td
p
If you use this parameter, you 
strong
must
 supply a value of 
code
icon
.
p
The x3 theme does not support group images.
td
code
icon
## Returns

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1