Return branding image's URL

This function retrieves a branding image's URL. 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

imagefile	string The image name, without the path or the extension. If you do not specify a value, the `needfile` parameter's value determines the function's action. Example: imagefile=image
needfile	integer Default: 0 Whether to return the `/unprotected/broken.gif` image with a failure message when the requested file does not exist. `1` - Return nothing. `0` - Return the image and a failure message. Enum: 0 1 Example: needfile=0
nomagic	integer Default: 0 Whether to include the `cPanel_magic_revision_##########` prefix in the `uri` image path. `1` - Do not include the prefix. `0` - Include the prefix. Enum: 0 1 Example: nomagic=0
reqext	string The image's file extension. `.jpg` `.ico` `.gif` `.png` Enum: ".jpg" ".ico" ".gif" ".png" Example: reqext=.png
skip_logo_check	integer Default: 0 Whether to only return the filename. `1` - Return the image's file. `0` - Return the image's URL. Enum: 0 1 Example: skip_logo_check=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/image

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Branding \
  image

Response samples

application/json

{"apiversion": 3,
"func": "image",
"module": "Branding",
"result": {"data": {"path": "/usr/local/cpanel/base/frontend/paper_lantern/branding/image.png",
"uri": "/cPanel_magic_revision_1327526145/frontend/paper_lantern/branding/image.png"
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}