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/get_provider_display_configurations
- A server running WHM.
https://whm-server.tld:2087/json-api/get_provider_display_configurations
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
get_provider_display_configurations \
provider_id='google'Response
application/json
{ "data": { "configurations": [ … ] }, "metadata": { "command": "get_provider_display_configurations", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_users_authn_linked_accounts
- A server running WHM.
https://whm-server.tld:2087/json-api/get_users_authn_linked_accounts
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
get_users_authn_linked_accountsResponse
application/json
{ "data": { "username_linked_accounts": [ … ] }, "metadata": { "command": "get_users_authn_linked_accounts", "reason": "OK", "result": 1, "version": 1 } }
- 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
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
link_user_authn_provider \
username='example' \
provider_id='google' \
subject_unique_identifier='123456789012345678901' \
preferred_username='Example'Response
application/json
{ "metadata": { "command": "link_user_authn_provider", "reason": "OK", "result": 1, "version": 1 } }