# cPanel API 2 Functions - Branding::spritelist

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 lists sprite information and locations.

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

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&img="getstart"&imgtype="icon"&method="skip_filetype_gif"&subtype="img"
```

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.

// List sprite information for the Getting Started Wizard.
$list_sprites = $cpanel->api2(
    'Branding', 'gensprites',
        array(       
            'img'           => 'getstart',
            'imgtype'       => 'icon',
            'method'        => 'skip_filetype_gif',
            'subtype'       => 'img',
    )
 );
```

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.

# List sprite information for the Getting Started Wizard.
my $list_sprites = $cpliveapi->api2(
    'Branding', 'gensprites',
    {
            'img'           => 'getstart',
            'imgtype'       => 'icon',
            'method'        => 'skip_filetype_gif',
            'subtype'       => 'img',
    }
 );
```

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 img=getstart imgtype=icon method=skip_filetype_gif subtype=img
```

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": "spritelist",
    "data": [
      {
        "images": [

        ],
        "spriteurl": "/cPanel_magic_revision_/"
      }
    ],
    "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
thead
tr
th
Input
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
image
td
em
string
td
Set this parameter to 
code
heading
 to force output.
td
code
heading
 is the only possible value.
td
code
heading
tr
td
code
img
td
em
string
td
p
strong
Required
p
The image's branding object's name.
td
The name of a branding object, from the 
code
dynamicui.conf
 file.
td
code
getstart
tr
td
code
imgtype
td
em
string
td
p
strong
Required
p
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
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
skipgroups
td
em
Boolean
td
p
Whether to return information for images that begin with 
code
group_
.
p
This value defaults to 
span
0
.
td
ul
li
code
1
 — Skip images that begin with 
code
group_
.
li
code
0
 — Include images that begin with 
code
group_
.
p
The x3 theme does not support group images.
td
code
0
tr
td
code
subtype
td
em
string
td
p
strong
Required
p
The image subtype.
td
ul
li
code
img
li
code
bg
li
code
compleximg
td
code
img
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
images
td
em
string
td
The list of images.
td
One or more image names.
td
br
tr
td
code
spriteurl
td
em
string
td
The sprite's path.
td
The sprite's path, relative to the user's home directory.
td
code
/cPanel_magic_revision/
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