WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
Request
This function returns a list of application keys (appkeys) and the URLs that correspond to applications for the cPanel user's theme. Use the appkey values for the app parameter's value in the WHM API 1 create_user_session function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_users_links
- A server running WHM.
https://whm-server.tld:2087/json-api/get_users_links
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_users_links?user=user&service=cpaneld'HTTP Request was successful.
A list of appkeys and their corresponding file locations.
Example: {"Backups_Home":"frontend/jupiter/backup/index.html","Calendar_Configure":"frontend/jupiter/mail/calendars_and_contacts/index.html","ContactInfo_Change":"frontend/jupiter/contact/index.html","Cron_Home":"frontend/jupiter/cron/index.html","Database_MySQL":"frontend/jupiter/sql/index.html","Database_phpMyAdmin":"frontend/jupiter/sql/PhpMyAdmin.html","Email_AccountLevelFiltering":"frontend/jupiter/mail/filters/userfilters.html","Email_Accounts":"frontend/jupiter/mail/pops/index.html","Email_Archive":"frontend/jupiter/mail/archive.html","Email_Authentication":"frontend/jupiter/mail/auth.html","Email_AutoResponders":"frontend/jupiter/mail/autores.html","Email_BoxTrapper":"frontend/jupiter/mail/boxtrapper.html","Email_DefaultAddress":"frontend/jupiter/mail/def.html","Email_DeliveryReport":"frontend/jupiter/mail/def.html","Email_Disk_Usage":"frontend/jupiter/mail/manage_disk_usage/","Email_Forwarders":"frontend/jupiter/mail/fwds.html","Email_GreyListing":"frontend/jupiter/mail/greylisting/index.html","Email_MailingLists":"frontend/jupiter/mail/lists.html","Email_Routing":"frontend/jupiter/mail/email_routing.html","Email_SpamFilter":"frontend/jupiter/mail/spam/spam.html","Email_UserLevelFiltering":"frontend/jupiter/mail/filters/managefilters.html","FileManager_Home":"frontend/jupiter/filemanager/index.html","Locale_Change":"frontend/jupiter/setlang/index.html","Password_Change":"frontend/jupiter/passwd/index.html","SSL_TLS_Manager":"frontend/jupiter/ssl/index.html","SSL_TLS_Status":"frontend/jupiter/security/tls_status/","SSL_TLS_Wizard":"frontend/jupiter/security/tls_wizard/","Site_Software":"frontend/jupiter/addoncgi/cpaddons.html","Solr_Disk_Usage":"frontend/jupiter/mail/search_index/","Stats_AWStats":"frontend/jupiter/stats/awstats_landing.html"}
Response
application/json
{ "data": { "Backups_Home": "frontend/jupiter/backup/index.html", "Calendar_Configure": "frontend/jupiter/mail/calendars_and_contacts/index.html", "ContactInfo_Change": "frontend/jupiter/contact/index.html", "Cron_Home": "frontend/jupiter/cron/index.html", "Database_MySQL": "frontend/jupiter/sql/index.html", "Database_phpMyAdmin": "frontend/jupiter/sql/PhpMyAdmin.html", "Email_AccountLevelFiltering": "frontend/jupiter/mail/filters/userfilters.html", "Email_Accounts": "frontend/jupiter/mail/pops/index.html", "Email_Archive": "frontend/jupiter/mail/archive.html", "Email_Authentication": "frontend/jupiter/mail/auth.html", "Email_AutoResponders": "frontend/jupiter/mail/autores.html", "Email_BoxTrapper": "frontend/jupiter/mail/boxtrapper.html", "Email_DefaultAddress": "frontend/jupiter/mail/def.html", "Email_DeliveryReport": "frontend/jupiter/mail/def.html", "Email_Disk_Usage": "frontend/jupiter/mail/manage_disk_usage/", "Email_Forwarders": "frontend/jupiter/mail/fwds.html", "Email_GreyListing": "frontend/jupiter/mail/greylisting/index.html", "Email_MailingLists": "frontend/jupiter/mail/lists.html", "Email_Routing": "frontend/jupiter/mail/email_routing.html", "Email_SpamFilter": "frontend/jupiter/mail/spam/spam.html", "Email_UserLevelFiltering": "frontend/jupiter/mail/filters/managefilters.html", "FileManager_Home": "frontend/jupiter/filemanager/index.html", "Locale_Change": "frontend/jupiter/setlang/index.html", "Password_Change": "frontend/jupiter/passwd/index.html", "SSL_TLS_Manager": "frontend/jupiter/ssl/index.html", "SSL_TLS_Status": "frontend/jupiter/security/tls_status/", "SSL_TLS_Wizard": "frontend/jupiter/security/tls_wizard/", "Site_Software": "frontend/jupiter/addoncgi/cpaddons.html", "Solr_Disk_Usage": "frontend/jupiter/mail/search_index/", "Stats_AWStats": "frontend/jupiter/stats/awstats_landing.html" }, "metadata": { "command": "get_users_links", "reason": "OK", "result": 1, "version": 1 } }