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/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/link_user_authn_provider
- A server running WHM.
https://whm-server.tld:2087/json-api/link_user_authn_provider
- 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/link_user_authn_provider?preferred_username=Example&provider_id=google&subject_unique_identifier=123456789012345678901&username=example'Response
application/json
{ "metadata": { "command": "link_user_authn_provider", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_provider_client_configurations
- A server running WHM.
https://whm-server.tld:2087/json-api/set_provider_client_configurations
- 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/set_provider_client_configurations?configurations={%22client_id%22%3A%22victoria%22%2C%22client_secret%22%3A%22secret%22}&provider_id=cpanelid&service_name=cpaneld'Response
application/json
{ "metadata": { "command": "set_provider_client_configurations", "reason": "OK", "result": 1, "version": 1 } }
Query
The display configuration in JSON-encoded key-value format.
Example: configurations={"color":"6677aa","display_name":"Hosting Center Login","textcolor":"44ffbb"}
The background color of the button on the cPanel interface.
Example: "6677aa"
The display name of the identity provider.
Example: "Hosting Center Login"
The icon file to display in the button on the cPanel login interface.
Example: "iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN\\/\\/KkqMh2yYvt53S3KygomIZaE+y9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1\\/xs1klJn8J\\/gZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO+Kv0Wb9Z7xlZr+wMt8f\\/ANmyCoCMF3CUmP8rOmHip1AM\\/8tdbLcjfnL5NigYmIp+ilp5iYRJNkmajtLIBuJiUZ1S+aDKGDjI8tGk+N\\/9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw+IVtUCP3KEpdojffHnRGKcq3LZ3pBgST+BRgANXt+WPKE7tYAAAAASUVORK5CYII="
The icon file's MIME type.
Default "image/svg+xml"
Example: "image/svg+xml"
The text label that will appear on the cPanel login interface.
Example: "Log in with a cPanelID Account"
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_provider_display_configurations
- A server running WHM.
https://whm-server.tld:2087/json-api/set_provider_display_configurations
- 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/set_provider_display_configurations?configurations={%22color%22%3A%226677aa%22%2C%22display_name%22%3A%22Hosting+Center+Login%22%2C%22textcolor%22%3A%2244ffbb%22}&provider_id=cpanelid&service_name=cpaneld'Response
application/json
{ "metadata": { "command": "set_provider_display_configurations", "reason": "OK", "result": 1, "version": 1 } }