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/
Query
The group's ID within the system.
Warning:
If you create a link with a group_id value that already exists, the function replaces the existing group with the newly-created group.
Example: group_id=WHMCS
The label for the group to display in the cPanel interface.
Example: label=WHMCS+Control
The order in which to display the group in the cPanel interface.
Note:
By default, the function will automatically create an item under the username menu in the interface header.
Example: order=1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/create_integration_group
- A server running WHM.
https://whm-server.tld:2087/json-api/create_integration_group
- 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/create_integration_group?group_id=WHMCS&label=WHMCS%2BControl&order=1&user=username'Response
application/json
{ "metadata": { "command": "create_integration_group", "reason": "Ok", "result": 1, "version": 1 } }
Request
This function creates an integration link in the cPanel interface.
Note:
The function creates the APP.adminconfig and APP.userconfig integration link files in the /var/cpanel/integration/links/USERNAME directory, where APP represents the application name and USERNAME represents the user for whom you create integration links.
Security
BasicAuth
Query
The application to link.
Note:
- If you create a link with an
appvalue that already exists, the function will replace the existing link with the newly-created link. - The value you assign to the
appparameter is how you identify that integration link when listing or removing integration links. - You may include underscore (
_) characters.
Example: app=WHMCS_billing
The service for which to implement authentication.
Note:
This is a string from the get_users_links function. The function typically returns one of the following values.
billing- This link appears in the user menucustomer_service- This link appears in the user menusupport- This link appears in the user menuupgrade- This link appears in the user menu and context-sensitive areas when the user may require more of a resource
Example: implements=billing
The subscriber's unique ID that the system will present to the URL in the autologin_token_url endpoint.
Example: subscriber_unique_id=1234
The token that the system will present to the URL in the autologin_token_url endpoint.
Example: token=subway
The URL to which the server will send the app, token, user, and subscriber_unique_id values through an HTTP POST request. The destination server will respond with a JSON-encoded object with either a redirect_url key or the retry and attempt keys.
Note:
- You must include either the
autologin_token_urlparameter, theurlparameter, or both. - If you do not set the
autologin_token_urlparameter, or that server does not respond or exist, then the server will redirect the user to the location in theurlparameter. - If the response contains
redirect_url, the system will redirect the user to that URL. (For example:,{"redirect_url":" http://www.whmcs.com/client_area/login/?one_time_user_token_that_expires_in_120_seconds=d41d8cd98f00 ”}will send the user to that unique URL.) - If the response contains
retryandattempt, the system will wait for the retry value in seconds for a maximum of 60 seconds and then attempt the call again. The attempt value indicates the number of attempts that your system has tried. The system will stop after three attempts. (For example,{"retry":30, "attempt":2}represents the second attempt to connect, and the system will pause the user for 30 seconds before it tries again.)
Example: autologin_token_url=http://www.example.com/login.cgi
The icon image.
Note:
If you do not specify a value, the interface uses a standard puzzle piece icon.
Example: base64_png_image=iVBORw0KGgoAAAANSUhEUgAAAJgAAADYCAYAAA AXmipNAAAACXBIWXMAAALVAAAC1QHAwm8lAAAAGXRFWHRTb2Z0d2FyZQB 3d3cuaW5rc2NhcGUub3Jnm+48GgAAAUNJREFUeJztziFKg2EABuD3+ydz qGBwiGBZ385hstoMu4DNA8w7eIuBRUyWBYvJsC6CYWCwGGSy7bN6AOFn8 DwneJI/6mTYreNBryYl8A9KktTxoJfu0W66y3mSw6Q8pD+/LJNsWv6x5Z p6NbzJ/sF7uj/3Sf3OJqPUep6P0WnbObZfk1qu02zOks0spXylk+eUvOS 4v2g7x/bbSamPSecuqZ+p5TbN6inLvbcyma3azrH9Sr1IJyejQcq6yWL0 WqbTddspAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AANr0C5EmMYv5JZrpAAAAAElFTkSuQmCC
The group ID in which to add the icon of the linked service.
filesdatabasesdomainsemailmetricssecuritysoftwareadvancedpref
Note:
If you do not specify a value, the function automatically creates an item under the username menu in the interface header.
Enum"files""databases""domains""email""metrics""security""software""advanced""pref"
Example: group_id=advanced
Whether the cPanel interface will display the integration link.
1- Do not display the link.0- Display the link.
Default 0
Enum01
Example: hide=1
The order in which to display the icon in the cPanel interface inside the group_id group.
Example: order=999
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/create_integration_link
- A server running WHM.
https://whm-server.tld:2087/json-api/create_integration_link
- 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/create_integration_link?app=WHMCS_billing&implements=billing&label=WHMCS+Billing&subscriber_unique_id=1234&token=subway&user=username&autologin_token_url=http%3A%2F%2Fwww.example.com%2Flogin.cgi&base64_png_image=iVBORw0KGgoAAAANSUhEUgAAAJgAAADYCAYAAA+AXmipNAAAACXBIWXMAAALVAAAC1QHAwm8lAAAAGXRFWHRTb2Z0d2FyZQB+3d3cuaW5rc2NhcGUub3Jnm%2B48GgAAAUNJREFUeJztziFKg2EABuD3%2Bydz+qGBwiGBZ385hstoMu4DNA8w7eIuBRUyWBYvJsC6CYWCwGGSy7bN6AOFn8+DwneJI%2F6mTYreNBryYl8A9KktTxoJfu0W66y3mSw6Q8pD%2B%2FLJNsWv6x5Z+p6NbzJ%2FsF7uj%2F3Sf3OJqPUep6P0WnbObZfk1qu02zOks0spXylk%2BeUvOS+4v2g7x%2FbbSamPSecuqZ%2Bp5TbN6inLvbcyma3azrH9Sr1IJyejQcq6yWL0+WqbTddspAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA+AANr0C5EmMYv5JZrpAAAAAElFTkSuQmCC&group_id=advanced&hide=1&order=999&url=http%3A%2F%2Fwww.example.com'Response
application/json
{ "metadata": { "command": "create_integration_link", "reason": "Ok", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_integration_link_user_config
- A server running WHM.
https://whm-server.tld:2087/json-api/get_integration_link_user_config
- 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_integration_link_user_config?app=WHMCS_billing&user=username'Response
application/json
{ "data": { "userconfig": { … } }, "metadata": { "command": "get_integration_link_user_config", "reason": "OK", "result": 1, "version": 1 } }