Return sprite URL

This function retrieves a sprite URL. Sprites store the cPanel interface's icons as a single image to conserve bandwidth. Note: This function only works in the Paper Lantern theme. We deprecated Paper Lantern in cPanel & WHM version 100 and will remove the function in version 110. This function will not work in the Jupiter theme.

SecurityBasicAuth
Request
query Parameters
img
required
string

The image's branding object's name which comes from the dynamicui.conf file.

Example: img=getstart
imgtype
required
string

The image type.

Value: "icon"
Example: imgtype=icon
method
required
string

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.
Enum: "only_filetype_gif" "skip_filetype_gif" "snap_to_smallest_width" "scale_60percent"
Example: method=only_filetype_gif
subtype
required
string

The image subtype.

  • img
  • bg
  • complexing
Enum: "img" "bg" "complexing"
Example: subtype=img
image
string

Set this parameter to heading to force output.

Value: "heading"
Example: image=heading
skipgroups
integer
Default: 0

Whether to return information for images that begin with the group_ prefix.

  • 1 — Skip images that begin with the group_ prefix.
  • 0 — Include images that begin with the group_ prefix.
Enum: 0 1
Example: skipgroups=0
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/Branding/spritelist
Request samples
uapi --output=jsonpretty \
  --user=username \
  Branding \
  spritelist \
  img='getstart' \
  imgtype='icon' \
  method='only_filetype_gif' \
  subtype='img'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "spritelist",
  • "module": "Branding",
  • "result": {
    • "data": {
      • "images": [ ],
      • "spriteurl": "/cPanel_magic_revision/"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}