v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Branding

Branding Files

Return branding file content from the active theme

This function retrieves and renders a branding file from the active theme. The file may be a Template Toolkit (.tt) file or a standard HTML/image file. When the file is a Template Toolkit file, the system processes it and returns the rendered output. Otherwise, the system returns the file's raw or HTML-encoded content.

get/Branding/include

Query parameters

filestring required

Example:header.tt

The relative path to the branding file within the theme directory.

datastring json

Example:{"logoColor":"blue","showBanner":1}

A JSON-encoded object containing additional variables to pass to the Template Toolkit template when rendering a .tt file. This parameter is ignored for non-template files.

raw0 | 1

Whether to return the raw file content without HTML encoding.

1 — Return the raw file content.
0 — Return HTML-encoded content. This is the default behavior.

This parameter has no effect when the file is a Template Toolkit (.tt) file.

skip_default0 | 1

Whether to skip the default branding fallback.

1 — Do not fall back to the default branding file if the theme-specific file does not exist. This parameter has no effect for accounts that do not have a branding package assigned; the theme fallback is always applied in that case.
0 — Fall back to the default branding file. This is the default behavior.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "include",
  "module": "Branding",
  "result": {
    "data": "<div class=\"header\">Welcome</div>",
    "status": 1
  }
}