Return current user's cPanel application details

This function retrieves information about the groups and applications in the authenticated user's cPanel interface.

SecurityBasicAuth

Request

query Parameters

nvarglist

string

A pipe-separated list of group names denoting the order in which to sort the groups. If you do not supply a value, the function does not sort the groups.

Note:

arglist is an alias for this parameter.

Example: nvarglist=pref|software|domains

Responses

200

HTTP Request was successful.

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

get/Branding/get_available_applications

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Branding \
  get_available_applications

Response samples

application/json

{"apiversion": 3,
"func": "get_available_applications",
"module": "Branding",
"result": {"data": {"default_group_order": {"advanced": 7,
"databases": 2,
"domains": 3,
"email": 4,
"files": 1,
"metrics": 5,
"preferences": 8,
"sample_apps": 9,
"security": 6,
"software": 6
},
"grouporder": ["files",
"databases",
"domains",
"email",
"metrics",
"security",
"software",
"advanced",
"preferences",
"pref"
],
"groups": [{"desc": "Files",
"group": "files",
"items": [{"acontent": "target=\"file_manager\"",
"base64_png_image": "",
"feature": "filemanager",
"file": "file_manager",
"group": "files",
"height": "48",
"if": "$HASROLE{'FileStorage'}",
"imgtype": "icon",
"implements": "FileManager_Home",
"itemdesc": "File Manager",
"itemorder": "1",
"key": "file_manager",
"onclick": "",
"plainitemdesc": "File Manager",
"searchtext": "File Manager file-manager",
"subtype": "img",
"target": "file_manager",
"type": "image",
"url": "filemanager/index.html",
"width": "48"
}
]
}
],
"implements": {"API_Tokens_Manager": "api_tokens",
"Backups_Home": "backup",
"Calendar_Configure": "calendar_and_contacts",
"ContactInfo_Change": "contact_information",
"Cron_Home": "cron_jobs",
"Database_MySQL": "mysql_databases",
"Database_phpMyAdmin": "php_my_admin",
"Domains_AddonDomains": "addon_domains",
"Domains_SubDomains": "subdomains",
"Email_AccountLevelFiltering": "global_email_filters",
"Email_Accounts": "email_accounts",
"Email_Authentication": "email_deliverability",
"Email_AutoResponders": "autoresponders",
"Email_BoxTrapper": "boxtrapper",
"Email_DefaultAddress": "default_address",
"Email_DeliveryReport": "track_delivery",
"Email_Disk_Usage": "email_disk_usage",
"Email_Forwarders": "forwarders",
"Email_MailingLists": "mailing_lists",
"Email_Routing": "email_routing",
"Email_SpamFilter": "apache_spam_assassin",
"Email_UserLevelFiltering": "email_filters",
"FileManager_Home": "file_manager",
"Locale_Change": "change_language",
"Password_Change": "change_password",
"SSL_TLS_Manager": "ssl_tls",
"SSL_TLS_Status": "tls_status",
"Site_Software": "site_software",
"Stats_AWStats": "awstats"
},
"index": {"addon_domains": [2,
2
],
"address_importer": [3,
10
],
"aliases": [2,
4
],
"analog_stats": [4,
5
],
"apache_handlers": [7,
5
],
"apache_spam_assassin": [3,
11
],
"api_tokens": [5,
3
],
"autoresponders": [3,
3
],
"awstats": [4,
4
],
"backup": [0,
5
],
"backup_wizard": [0,
6
],
"bandwidth": [4,
2
],
"boxtrapper": [3,
13
],
"calendar_and_contacts": [3,
14
],
"change_language": [8,
1
],
"change_password": [8,
0
],
"change_style": [8,
2
],
"contact_information": [8,
3
],
"cron_jobs": [7,
1
],
"default_address": [3,
4
],
"directory_privacy": [0,
2
],
"disk_usage": [0,
3
],
"domains": [2,
1
],
"email_accounts": [3,
0
],
"email_deliverability": [3,
9
],
"email_disk_usage": [3,
15
],
"email_filters": [3,
8
],
"email_routing": [3,
2
],
"encryption": [3,
12
],
"error_pages": [7,
4
],
"errors": [4,
1
],
"file_manager": [0,
0
],
"forwarders": [3,
1
],
"global_email_filters": [3,
7
],
"hotlink_protection": [5,
4
],
"images": [0,
1
],
"indexes": [7,
3
],
"ip_blocker": [5,
1
],
"leech_protection": [5,
5
],
"mailing_lists": [3,
5
],
"metrics_editor": [4,
7
],
"mime_types": [7,
6
],
"multiphp_ini_editor": [6,
5
],
"multiphp_manager": [6,
4
],
"mysql_database_wizard": [1,
2
],
"mysql_databases": [1,
1
],
"optimize_website": [6,
3
],
"perl_modules": [6,
1
],
"php_my_admin": [1,
0
],
"php_pear_packages": [6,
0
],
"raw_access": [4,
3
],
"redirects": [2,
5
],
"remote_mysql": [1,
3
],
"site_publisher": [2,
0
],
"site_software": [6,
2
],
"ssh_access": [5,
0
],
"ssl_tls": [5,
2
],
"subdomains": [2,
3
],
"terminal": [7,
0
],
"tls_status": [5,
6
],
"track_delivery": [3,
6
],
"track_dns": [7,
2
],
"user_manager": [8,
4
],
"version_control": [0,
7
],
"visitors": [4,
0
],
"web_disk": [0,
4
],
"webalizer": [4,
6
],
"zone_editor": [2,
6
]
}
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}