Return service status

This function reports which services (daemons) are enabled, installed, and monitored on your server.

Authorizations:
query Parameters
service
string

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

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  servicestatus

Response samples

Content type
application/json
{
  • "data": {
    • "service": [
      • {
        • "display_name": "Cron Daemon",
        • "enabled": 1,
        • "installed": 1,
        • "monitored": 1,
        • "name": "crond",
        • "running": 1
        }
      ]
    },
  • "metadata": {
    • "command": "servicestatus",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}