Return service and device status

This function returns the status of each cPanel service (daemon), device, and server health check point on your server.

SecurityBasicAuth

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/ServerInformation/get_information

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  ServerInformation \
  get_information

Response samples

application/json

{"apiversion": 3,
"func": "get_information",
"module": "ServerInformation",
"result": {"data": [{"name": "apache_php_fpm",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "cpanel-dovecot-solr",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "cpanellogd",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "cpdavd",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "cphulkd",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "cpsrvd",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "crond",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "dnsadmin",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "exim",
"status": 1,
"type": "service",
"value": "up",
"version": "exim-4.92-1.cp1180.x86_64"
},
{"name": "ftpd",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "httpd",
"status": 1,
"type": "service",
"value": "up",
"version": "2.4.39"
},
{"name": "imap",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "ipaliases",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "lmtp",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "mailman",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "mysql",
"status": 1,
"type": "service",
"value": "up",
"version": "5.7.25"
},
{"name": "named",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "nscd",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "pop",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "queueprocd",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "rsyslogd",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "spamd",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "sshd",
"status": 1,
"type": "service",
"value": "up"
},
{"name": "Server Load",
"status": 1,
"type": "metric",
"value": "1.73"
},
{"name": "CPU Count",
"status": 1,
"type": "metric",
"value": "2"
},
{"name": "Memory Used",
"status": 1,
"type": "device",
"value": "44.12%"
},
{"name": "Swap",
"status": 1,
"type": "device",
"value": "0.73%"
},
{"name": "Disk / (/)",
"status": 1,
"type": "device",
"value": "26%"
},
{"name": "Disk /tmp (/tmp)",
"status": 1,
"type": "device",
"value": "0%"
},
{"name": "Disk /var/tmp (/var/tmp)",
"status": 1,
"type": "device",
"value": "0%"
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}