Return single app's info from dynamicui.conf

This function retrieves an application's information from the dynamicui.conf file.

Authorizations:
query Parameters
app_key
required
string

The application's feature name. This value must match a feature's app_key value. For a list of app_key values, read our Guide to cPanel Interface Customization - Appkeys documentation.

Example: app_key=boxtrapper

Responses

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

Request samples

uapi --output=jsonpretty \
  --user=username \
  Branding \
  get_application_information \
  app_key='boxtrapper'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_application_information",
  • "module": "Branding",
  • "result": {
    • "data": {
      • "feature": "boxtrapper",
      • "file": "boxtrapper",
      • "group": "mail",
      • "height": 32,
      • "if": "!$CONF{'skipboxtrapper'} $CPDATA{'FEATURE-BOXTRAPPER'}",
      • "imgtype": "icon",
      • "itemdesc": "BoxTrapper",
      • "itemorder": 3,
      • "module": "BoxTrapper",
      • "searchtext": "boxtrapper",
      • "subtype": "img",
      • "type": "image",
      • "url": "mail/boxtrapper.html",
      • "width": 35
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}