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 restarts a service, or daemon, on a server.
Note:
If the user only possesses the clustering Access Control List (ACL) then this function can only act on the named service.
Security
BasicAuth
Query
The service to restart. For a list of possible values, read our Access Control List (ACL) documentation.
Example: service=exim
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/restartservice
- A server running WHM.
https://whm-server.tld:2087/json-api/restartservice
- 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/restartservice?service=exim&queue_task=0'Response
application/json
{ "data": { "output": "Waiting for httpd to restart..............finished.\\n\\nhttpd (/usr/local/apache/bin/httpd -k start -DSSL) running as root with PID 21379\\nhttpd (/usr/local/apache/bin/httpd -k start -DSSL) running as root with PID 21385\\n\\nhttpd started ok\\n", "service": "exim" }, "metadata": { "command": "restartservice", "reason": "OK", "result": 1, "version": 1 } }
Query
The service for which to view the status.
Notes
If you do not specify this parameter, the function will return the status for all of your server's services.
Available Services:
- apache_php_fpm
- clamd
- cpanel-dovecot-solr
- cpanel_php_fpm
- cpanellogd
- cpdavd
- cpgreylistd
- cphulkd
- cpsrvd
- crond
- dnsadmin
- exim
- exim-altport
- ftpd
- httpd
- imap
- ipaliases
- lmtp
- mailman
- mysql
- named
- nscd
- p0f
- pop
- postgresql
- queueprocd
- rsyslogd
- spamd
- sshd
- syslogd
- tailwatchd
For more information about these services, read our Service Manager documentation.
Example: service=crond
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/servicestatus
- A server running WHM.
https://whm-server.tld:2087/json-api/servicestatus
- 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/servicestatus?service=crond'Response
application/json
{ "data": { "service": [ … ] }, "metadata": { "command": "servicestatus", "reason": "OK", "result": 1, "version": 1 } }
Query
The configuration key's name.
- This parameter uses the key names listed in the
/var/cpanel/conf/{service}/mainfile, where {service} is the service's name from the service parameter. - This function does not support subkeys.
Example: key=mail_process_size
The service's name.
- A list of service names exists in the
/var/cpanel/confdirectory.
Example: service=dovecot
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_service_config_key
- A server running WHM.
https://whm-server.tld:2087/json-api/set_service_config_key
- 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_service_config_key?key=mail_process_size&service=dovecot&value=512'Response
application/json
{ "metadata": { "command": "set_service_config_key", "reason": "Succeeded", "result": 1, "version": 1 } }