---
title: "Return registered applications"
method: GET
path: "/get_appconfig_application_list"
tags: ["Server Administration", "Applications"]
---

# Return registered applications

`GET /get_appconfig_application_list`

This function lists registered [AppConfig](https://go.cpanel.net/appconfig) applications.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `cpanel` AppConfig[] — An array of objects representing the values set for application installed for cPanel.
      - `acls` string[] — The ACL(s) with permission to run the application.
      - `displayname` string — The application's WHM display label. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `entryurl` string, url-path — The application's WHM entry URL. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `features` string[] — The required features to run the application.
      - `group` string — The application's group.
      - `icon` string — The application's icon file, relative to the `/usr/local/cpanel/whostmgr/docroot/addon_plugins/` directory. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `name` string — The application's name.
      - `origin` string — The application's configuration file. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `phpConfig` string, path — The application's `php.ini` file, relative to the `/usr/local/cpanel/3rdparty/etc/` directory.
      - `target` string, path — The action's target directory. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `upgradecall` string, path — The absolute file path to the application's upgrade script. **Note:** * The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig). * The system passes upgrade information in the following format: `/usr/local/youraddon/bin/upgrade 11.36.0.0 11.38.0.0`, where: * `11.36.0.0` is the **previous** cPanel & WHM version. * `11.38.0.0` is the **current** cPanel & WHM version.
      - `url` string, url-path — The application's URL path.
      - `user` string — The application's username.
    - `webmail` AppConfig[] — An array of objects representing the values set for application installed for Webmail.
      - `acls` string[] — The ACL(s) with permission to run the application.
      - `displayname` string — The application's WHM display label. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `entryurl` string, url-path — The application's WHM entry URL. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `features` string[] — The required features to run the application.
      - `group` string — The application's group.
      - `icon` string — The application's icon file, relative to the `/usr/local/cpanel/whostmgr/docroot/addon_plugins/` directory. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `name` string — The application's name.
      - `origin` string — The application's configuration file. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `phpConfig` string, path — The application's `php.ini` file, relative to the `/usr/local/cpanel/3rdparty/etc/` directory.
      - `target` string, path — The action's target directory. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `upgradecall` string, path — The absolute file path to the application's upgrade script. **Note:** * The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig). * The system passes upgrade information in the following format: `/usr/local/youraddon/bin/upgrade 11.36.0.0 11.38.0.0`, where: * `11.36.0.0` is the **previous** cPanel & WHM version. * `11.38.0.0` is the **current** cPanel & WHM version.
      - `url` string, url-path — The application's URL path.
      - `user` string — The application's username.
    - `whostmgr` AppConfig[] — An array of objects representing the values set for application installed for WHM.
      - `acls` string[] — The ACL(s) with permission to run the application.
      - `displayname` string — The application's WHM display label. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `entryurl` string, url-path — The application's WHM entry URL. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `features` string[] — The required features to run the application.
      - `group` string — The application's group.
      - `icon` string — The application's icon file, relative to the `/usr/local/cpanel/whostmgr/docroot/addon_plugins/` directory. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `name` string — The application's name.
      - `origin` string — The application's configuration file. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `phpConfig` string, path — The application's `php.ini` file, relative to the `/usr/local/cpanel/3rdparty/etc/` directory.
      - `target` string, path — The action's target directory. **Note:** The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig).
      - `upgradecall` string, path — The absolute file path to the application's upgrade script. **Note:** * The function **only** returns this value for plugins that you register with [AppConfig](https://go.cpanel.net/appconfig). * The system passes upgrade information in the following format: `/usr/local/youraddon/bin/upgrade 11.36.0.0 11.38.0.0`, where: * `11.36.0.0` is the **previous** cPanel & WHM version. * `11.38.0.0` is the **current** cPanel & WHM version.
      - `url` string, url-path — The application's URL path.
      - `user` string — The application's username.
  - `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)