---
title: "Return dynamicui file"
method: GET
path: "/get_available_applications"
tags: ["Packages", "Feature Lists"]
---

# Return dynamicui file

`GET /get_available_applications`

This function returns the contents of a `dynamicui` file. For more
information, read our
[Guide to WHM dynamicui Files](https://go.cpanel.net/GuidetoWHMdynamicuiFiles)
documentation.

## Query parameters

- `applications_list` string
- `file` string

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `groups` Group[] — An array of objects containing the file's contents.
      - `acl` string, nullable, required — The group's Access Control Lists (ACLs). **Note:** * Only WHM users who possess the specified ACLs can view or use the item. * System administrators can configure users' ACLs in WHM's [*Edit Reseller Nameservers and Privileges*](https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges) interface (*WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges*). * For a complete list of available ACLs, read our [Guide to WHM Plugins - ACL Reference Chart](https://go.cpanel.net/ACLReferenceChart) documentation.
      - `dnsonly_ok` 'dns', nullable, required — The group's status for [cPanel DNSOnly](https://go.cpanel.net/cpanel-dnsonly)™ servers. * `dns` - The group appears on cPanel DNSOnly servers. * `` - The group does not appear on cPanel DNSOnly servers.
      - `file` string, required — The icon file to display for the group. **Note:** * Icons for any WHM plugins exist separately from the server's theme. For more information, read our [Guide to WHM Plugins - Plugin Files](https://go.cpanel.net/whmpluginfiles) documentation. * A valid `.png` or `.svg` image file, relative to the theme's icon directory.
      - `group` string, required — The group name.
      - `groupdesc` string, required — The group's display name. **Note:** You can localize this string to display it in the user's preferred language in the WHM interface. For more information, read our [Guide to Locales](https://go.cpanel.net/guide-to-locales) documentation
      - `grouporder` integer, required — The group's display order in the WHM interface. **Note:** Lower values appear at the top of the interface
      - `imgtype` 'icon' — The group's image type. * `icon` - The only possible value.
      - `items` Image[]
        - `acl` string, nullable, required — The feature's Access Control Lists (ACLs). **Note:** * Only WHM users who possess the specified ACLs can view or use the item. * System administrators can configure users' ACLs in WHM's [*Edit Reseller Nameservers and Privileges*](https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges) interface (*WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges*). * For a complete list of available ACLs, read our [Guide to WHM Plugins - ACL Reference Chart](https://go.cpanel.net/ACLReferenceChart) documentation.
        - `description` string, required — The feature's description that displays when the feature appears on the WHM Home interface. **Note:** You can localize this string to display it in the user's preferred language in the WHM interface. For more information, read our [Guide to Locales](https://go.cpanel.net/guide-to-locales) documentation.
        - `dnsonly_ok` 'dns', nullable, required — The group's status for [cPanel DNSOnly](https://go.cpanel.net/cpanel-dnsonly)™ servers. * `dns` - The group appears on cPanel DNSOnly servers. * `` - The group does not appear on cPanel DNSOnly servers.
        - `file` string, required — The icon file to display for the group. **Note:** * Icons for any WHM plugins exist separately from the server's theme. For more information, read our [Guide to WHM Plugins - Plugin Files](https://go.cpanel.net/whmpluginfiles) documentation. * A valid `.png` or `.svg` image file, relative to the theme's icon directory.
        - `group` string, required — The group in which the item appears. This is a value of an existing group object.
        - `imgtype` 'icon' — The feature's image type. * `icon` - The only possible value.
        - `itemdesc` string — The feature's display name. **Note:** * You can localize this string to display it in the user's preferred language in the WHM interface. For more information, read our [Guide to Locales](https://go.cpanel.net/guide-to-locales) documentation. * This should be a [Template Toolkit](https://go.cpanel.net/tmpltoolkit) directive.
        - `itemorder` integer, required — The feature's display order within its group. **Note:** Lower values appear earlier in the group.
        - `key` string — A key to uniquely identify WHM interfaces and their associated assets for the [cPanel Analytics](https://go.cpanel.net/analytics) program. **Note:** Generally, this value matches the `file` parameter's value without the file's extension.
        - `minimum_accounts_needed` integer — The minimum number of accounts required to display the feature icon.
        - `multiuser_required` 1 — Whether the server allows for the creation of more than a single user. * `1` — Display the feature icon. * `0` — Do **not** display the feature icon. **Note:** You **cannot** use this parameter on servers with a [cPanel Solo License](https://go.cpanel.net/cpanel-solo-license).
        - `role` union — The feature's server role. **Warning:** The server creates this parameter automatically. Do **not** edit this parameter's value. We do **not** support customizations to this parameter. **Note:** * The icon only appears in the interface if the server configuration uses this role. * For more information about roles and server configurations, read our [How to Use Server Profiles](https://go.cpanel.net/howtouseserverprofiles) documentation.
          - object
            - `match` 'any' — Whether to require all roles in the roles parameter to match the server's roles. * `all` - Require the server to match all roles in the roles parameter to display the feature. (AND condition) * `any` - Require the server to match any role in the roles parameter to display the feature. (OR condition)
            - `roles` string[] — The array of role names.
          - string
        - `searchtext` string — A list search terms for the feature, space delimited.
        - `service` union — The [cPanel Service Daemon](https://go.cpanel.net/ThecPanelWHMServiceDaemons) that monitors the feature. **Warning:** The server creates this parameter automatically. Do **not** edit this parameter's value. We do not support customizations to this parameter. **Note:** * This icon only appears on servers with the service enabled. * For a complete list of service daemons, read our [cPanel Service Daemons](https://go.cpanel.net/ThecPanelWHMServiceDaemons) documentation.
          - object
            - `match` 'any' — Whether to require all services in the services parameter to match enabled services on the server. * `all` - Require the server to match **all** services under the `services` key to display the feature. (AND condition) * `any` - Require the server to match any service under the `services` key to display the feature. (OR condition)
            - `services` string[] — An array of services.
          - string
        - `subitems` Subitem[]
          - `acl` string, nullable, required — The subitem's Access Control Lists (ACLs). **Note:** * Only WHM users who possess the specified ACLs can view or use the item. * System administrators can configure users' ACLs in WHM's [*Edit Reseller Nameservers and Privileges*](https://go.cpanel.net/whmdocsEditResellerNameserversandPrivileges) interface (*WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges*). * For a complete list of available ACLs, read our [Guide to WHM Plugins - ACL Reference Chart](https://go.cpanel.net/ACLReferenceChart) documentation.
          - `breadcrumb` string, url-path, required — A subitem's parent feature's location. * The system uses this value to generate breadcrumbs at the top of each WHM interface. * The subitem's parent feature's `url` value.
          - `dnsonly_ok` 'dns', nullable, required — The subitem's status for [cPanel DNSOnly](https://go.cpanel.net/cpanel-dnsonly)™ servers. * `dns` - The subitem appears on cPanel DNSOnly servers. * `` - The subitem does not appear on cPanel DNSOnly servers.
          - `file` string, required — The icon file to display for the subitem. **Note:** * Icons for any WHM plugins exist separately from the server's theme. For more information, read our [Guide to WHM Plugins - Plugin Files](https://go.cpanel.net/whmpluginfiles) documentation. * A valid `.png` or `.svg` image file, relative to the theme's icon directory.
          - `group` string, required — The group in which the subitem appears. This is a value of an existing group object.
          - `itemdesc` string — The subitem's display name. **Note:** * You can localize this string to display it in the user's preferred language in the WHM interface. For more information, read our [Guide to Locales](https://go.cpanel.net/guide-to-locales) documentation.
          - `key` string — A key to uniquely identify WHM interfaces and their associated assets for the [cPanel Analytics](https://go.cpanel.net/analytics) program. **Note:** Generally, this value matches the `file` parameter's value without the file's extension.
          - `parent` integer, required — The subitem's parent feature's display order in the WHM interface. This is the parent feature's `itemorder` value.
          - `searchtext` string — A list search terms for the subitem, space delimited.
          - `target` string — The area of the interface in which the subitem displays. A valid HTML `<a>` target attribute.
          - `type` 'subitem', required — The object's type. * `subitem` - The only possible value.
          - `url` string, url-path, required — The subitem's interface location. This path is relative to the `/usr/local/cpanel/` directory.
        - `subtype` 'img' — The icon type to use. * `img` - The only possible value.
        - `target` string — The area of the interface in which the feature appears. A valid HTML `<a>` target attribute.
        - `type` 'image', required — The object's type. * `image` - The only possible value.
        - `url` string, url-path, required — The feature's interface location. This path is relative to the `/usr/local/cpanel/` directory.
      - `key` string — A key to uniquely identify WHM interfaces and their associated assets for the [cPanel Analytics](https://go.cpanel.net/analytics) program. **Note:** Generally, this value matches the `file` parameter's value without the file's extension.
      - `searchtext` string — A list of the group's search terms, space delimited.
      - `subtype` 'img' — The icon type to use. * `img` - The only possible value.
      - `target` string — The area of the interface in which the feature appears. A valid HTML `<a>` target attribute.
      - `type` string, required — The object's type.
    - `raw` Raw[] — An array of objects containing the file's raw data for template directives.
      - `itemdesc` string, required — A valid [Template Toolkit](https://go.cpanel.net/tmpltoolkit) directive.
      - `type` 'raw', required — The object's type. * `raw` - The only possible value. Raw data for template directives.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success * `0` - Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)