Return dynamicui file

This function returns the contents of a dynamicui file. For more information, read our Guide to WHM dynamicui Files documentation.

SecurityBasicAuth
Request
query Parameters
applications_list
string

A comma-separated list of the application entries to return.

To determine the application's name, find its file value in the dynamicui.conf file, and then remove the file extension.

If you do not specify this value, the function returns the entire dynamicui.conf file.

Example: applications_list=create_support_ticket
file
string
Default: "dynamicui.conf"

The dynamicui configuration file to retrieve, relative to the /usr/local/cpanel/whostmgr/docroot/themes/x/ directory.

Example: file=dynamicui.conf
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/get_available_applications
Request samples 
whmapi1 --output=jsonpretty \
  get_available_applications
Response samples
application/json
{
  • "data": {
    • "groups": [
      • {
        • "acl": "ACL=all",
        • "dnsonly_ok": "dns",
        • "file": "feature_name.png",
        • "group": "group_name",
        • "groupdesc": "$LANG{'Group Name'}",
        • "grouporder": 1,
        • "imgtype": "icon",
        • "items": [
          • {
            • "acl": "ACL=all",
            • "description": "View and manage reseller accounts on your server. Resellers manage other [asis,cPanel] accounts and can access [asis,cPanel].",
            • "dnsonly_ok": "dns",
            • "file": "feature_name.png",
            • "group": "group_name",
            • "imgtype": "icon",
            • "itemdesc": "$LANG{'Feature Name'}",
            • "itemorder": 1,
            • "key": "feature_name",
            • "minimum_accounts_needed": 2,
            • "multiuser_required": 1,
            • "role": {
              • "match": "any",
              • "roles": [
                • "MailLocal",
                • "MailSend"
                ]
              },
            • "searchtext": "search keywords",
            • "service": "mysql",
            • "subitems": [
              • {
                • "acl": null,
                • "breadcrumb": null,
                • "dnsonly_ok": null,
                • "file": null,
                • "group": null,
                • "itemdesc": null,
                • "key": null,
                • "parent": null,
                • "searchtext": null,
                • "target": null,
                • "type": null,
                • "url": null
                }
              ],
            • "subtype": "img",
            • "target": "_blank",
            • "type": "image",
            • "url": "/example_plugin/feature_name"
            }
          ],
        • "key": "feature_name",
        • "searchtext": "search keywords",
        • "subtype": "img",
        • "target": "_blank",
        • "type": "group"
        }
      ],
    • "raw": [
      • {
        • "itemdesc": "[% PROCESS 'menu/plugins_list.tmpl' target='mainFrame' -%]",
        • "type": "raw"
        }
      ]
    },
  • "metadata": {
    • "command": "get_available_applications",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}
©2024 WebPros International, LLC All rights reserved.Privacy PolicyTrademarks