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/removeacct
- A server running WHM.
https://whm-server.tld:2087/json-api/removeacct
- 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/removeacct?username=username&keepdns=0&user=username'Response
application/json
{ "metadata": { "command": "removeacct", "output": { … }, "reason": "example account removed", "result": 1, "version": 1 } }
Request
This function enables or disables Digest Authentication for an account. Windows Vista®, Windows® 7, and Windows® 8 requires that you enable Digest Authentication support in order to access your Web Disk over a clear text, unencrypted connection.
Note:
If the server has an SSL certificate that a recognized certificate authority signed and you can make an SSL connection over port 2078, you do not need to enable Digest Authentication.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_digest_auth
- A server running WHM.
https://whm-server.tld:2087/json-api/set_digest_auth
- 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_digest_auth?enabledigest=1&password=123456luggage&user=username&digestauth=1'Response
application/json
{ "metadata": { "command": "set_digest_auth", "reason": "Digest Authentication enabled.", "result": 1, "version": 1 } }
Query
Whether to prevent removal of user or group IDs currently in use.
1— Prevent removal.0— Do not prevent removal.
Default 1
Enum01
Example: check_exists=1
Whether to prevent removal of the user ID if the quota system tracks associated files.
1— Prevent removal.0— Do not prevent removal.
Note:
- This parameter only applies to user IDs and not group IDs.
- You cannot check filesystems if the quota system does not track them.
Default 1
Enum01
Example: check_quota=1
The group ID to remove from the track list.
Note:
You must include the uid parameter, the gid parameter, or both.
Example: gid=1012
Whether to prevent removal of system user or group IDs.
1— Prevent removal.0— Do not prevent removal.
Default 1
Enum01
Example: protect_system=1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/untrack_acct_id
- A server running WHM.
https://whm-server.tld:2087/json-api/untrack_acct_id
- 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/untrack_acct_id?check_exists=1&check_quota=1&gid=1012&protect_system=1&uid=1012'Response
application/json
{ "metadata": { "command": "untrack_acct_id", "reason": "OK", "result": 1, "version": 1 } }