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

 

Description

This function lists sprite information and locations. Sprites store the cPanel interface's icons as a single image to conserve bandwidth.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:


Note:

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.

Examples


 WHM API (JSON)
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 documentation.

 LiveAPI PHP Class
$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.

 

 LiveAPI Perl Module
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.

 

 cPanel Tag System (deprecated)


Warnings:

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


Notes:

  • 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:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "spritelist",
    "data": [
      {
        "images": [
          
        ],
        "spriteurl": "/cPanel_magic_revision_/"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Branding"
  }
}


Note:

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

 

Parameters

InputTypeDescriptionPossible valuesExample
imagestringSet this parameter to heading to force output.heading is the only possible value.heading
imgstring

Required

The image's branding object's name.

The name of a branding object, from the dynamicui.conf file.getstart
imgtypestring

Required

The image type.

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

The x3 theme does not support group images.

icon
methodstring

Required

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.

only_filetype_gif

skipgroupsBoolean

Whether to return information for images that begin with group_.

This value defaults to 0.

  • 1 — Skip images that begin with group_.
  • 0 — Include images that begin with group_.

The x3 theme does not support group images.

0
subtypestring

Required

The image subtype.

  • img
  • bg
  • compleximg 
img

 

Returns

ReturnTypeDescriptionPossible valuesExample
imagesstringThe list of images.One or more image names. 
spriteurlstringThe sprite's path.The sprite's path, relative to the user's home directory./cPanel_magic_revision/
resultBoolean

Whether the function succeeded.

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