You can retrieve information about system health using the health API.
Synopsis
|
GET /api/v2.0/health/
|
Request Headers
|
Host, Authorization
|
Response Headers
|
Content-Type, Content-Length, Connection
|
Sample Request
GET /esa/api/v2.0/health
HTTP/1.1
cache-control: no-cache
Postman-Token: a7eca7b8-0656-43db-b692-812396a86976
Authorization: Basic YWRtaW46aXJvbnBvcnQ=
Accept: */*
Host: esa.example.com:6080
accept-encoding: gzip, deflate
Connection: keep-alive
Sample Response
HTTP/1.0 200 OK
Server: API/2.0
Date: Thu, 12 Sept 2019 14:17:44 GMT
Content-type: application/json; charset=UTF-8
Content-Length: 5782
Connection: close
{
"meta": {
"totalCount": -1
},
"data": {
"percentage_ram_utilization": 5,
"messages_in_pvo_quarantines": 0,
"resource_conservation": 0,
"messages_in_workqueue": 0,
"percentage_swap_utilization": 0.0,
"percentage_queue_utilization": 0.0,
"percentage_diskio": 0,
"retry_delivery": "Scheduling all messages for delivery.",
"percentage_cpu_load": 13,
"reset_counters": "Counters have been reset.",
"delivery_status": [
{
"soft_bounces": 0,
"latest_host_status": "Unknown",
"hard_bounces": 0,
"active_recipients": 0,
"destination_domain": "funny.com",
"connections_out": 0,
"delivered_recipients": 10232
},
{
"soft_bounces": 0,
"latest_host_status": "Unknown",
"hard_bounces": 0,
"active_recipients": 0,
"destination_domain": "hello.com",
"connections_out": 0,
"delivered_recipients": 18328
},
{
"soft_bounces": 0,
"latest_host_status": "Unknown",
"hard_bounces": 0,
"active_recipients": 0,
"destination_domain": "sleep.com",
"connections_out": 0,
"delivered_recipients": 18328
},
{
"soft_bounces": 0,
"latest_host_status": "Unknown",
"hard_bounces": 0,
"active_recipients": 0,
"destination_domain": "stark.com",
"connections_out": 0,
"delivered_recipients": 27492
},
{
"soft_bounces": 0,
"latest_host_status": "Unknown",
"hard_bounces": 0,
"active_recipients": 0,
"destination_domain": "the.encryption.queue",
"connections_out": 0,
"delivered_recipients": 0
},
{
"soft_bounces": 0,
"latest_host_status": "Up",
"hard_bounces": 0,
"active_recipients": 0,
"destination_domain": "the.euq.queue",
"connections_out": 0,
"delivered_recipients": 79
},
{
"soft_bounces": 0,
"latest_host_status": "Unknown",
"hard_bounces": 0,
"active_recipients": 0,
"destination_domain": "the.euq.release.queue",
"connections_out": 0,
"delivered_recipients": 0
}
],
"system_status": {
"rates": [
{
"total_completed_recipients_rate_five": 8957,
"delivered_recipients_rate_one": 8440,
"messages_received_rate_five": 8824,
"hard_bounced_recipients_rate_one": 0,
"hard_bounced_recipients_rate_fifteen": 0,
"total_completed_recipients_rate_fifteen": 8762,
"recipients_received_rate_one": 8380,
"total_completed_recipients_rate_one": 8440,
"soft_bounced_events_rate_one": 0,
"delivered_recipients_rate_fifteen": 8762,
"recipients_received_rate_fifteen": 8759,
"soft_bounced_events_rate_fifteen": 0,
"messages_received_rate_one": 8380,
"soft_bounced_events_rate_five": 0,
"messages_received_rate_fifteen": 8759,
"delivered_recipients_rate_five": 8957,
"recipients_received_rate_five": 8824,
"hard_bounced_recipients_rate_five": 0
}
],
"version_details": [
{
"build_date": "2020-05-12",
"operating_system": "13.5.1-254",
"install_date": "2020-05-14 02:34:26",
"raid_status": "Unknown",
"serial_number": "4215B52370871114B954-609E45EE2D03",
"model": "C300V"
}
],
"gauges": [
{
"ram_utilization": "5%",
"email_security_appliance": "3%",
"msgs_in_work_queue": 0,
"disk_io_utilization": "0%",
"total_active_recipients": 0,
"current_outgoing_connections": 0,
"total_queue_utilized": "0.0%",
"anti_virus": "0%",
"msgs_in_quarantine": 0,
"quarantine": "0%",
"reporting": "2%",
"space_used_by_quarantine": "0B",
"unattempted": 0,
"logging_disk_utilization": "4%",
"attempted": 0,
"anti_spam": "25%",
"logging_disk_available": "350G",
"current_incoming_connections": 1,
"total_queue_space_used": "1KB",
"overall_cpu_load": "13%",
"dest_objects_in_memory": 7
}
],
"mail_system_status": [
{
"up_since": "4d 2h 12m 24s",
"system_status": "Online",
"oldest_message": "No Messages",
"status_as_of": "Thu May 14 02:32:20 2020 GMT"
}
],
"counters": [
{
"dns_reqs_reset": 7,
"dns_hard_bounces_reset": 0,
"total_hard_bounces_reset": 0,
"dropped_messages_uptime": 0,
"deleted_recipients_uptime": 0,
"net_reqs_lifetime": 13,
"dk_signed_lifetime": 0,
"dropped_messages_reset": 0,
"messages_received_uptime": 862484,
"expired_hard_bounces_uptime": 0,
"rejected_recipients_reset": 0,
"expired_hard_bounces_reset": 0,
"rejected_recipients_uptime": 0,
"expired_lifetime": 6,
"global_unsub_hits_reset": 0,
"recipients_received_uptime": 862484,
"five_xx_hard_bounces_uptime": 0,
"cache_misses_reset": 0,
"filter_hard_bounces_reset": 0,
"five_xx_hard_bounces_lifetime": 0,
"other_hard_bounces_reset": 0,
"dns_hard_bounces_uptime": 0,
"other_hard_bounces_lifetime": 0,
"total_hard_bounces_uptime": 0,
"cache_hits_reset": 7,
"rejected_recipients_lifetime": 7,
"dns_reqs_uptime": 862794,
"net_reqs_uptime": 7,
"deleted_recipients_lifetime": 0,
"delivered_recipients_uptime": 862484,
"dns_reqs_lifetime": 1298528,
"exceptions_lifetime": 1298515,
"delivered_recipients_lifetime": 1311178,
"exceptions_reset": 7,
"delivered_recipients_reset": 0,
"total_completed_recipients_lifetime": 1311178,
"cache_misses_lifetime": 13,
"generated_bounce_recipients_uptime": 0,
"total_completed_recipients_uptime": 862484,
"net_reqs_reset": 0,
"pending_requests": 0,
"global_unsub_hits_uptime": 0,
"cache_hits_uptime": 862794,
"dk_signed_uptime": 0,
"other_hard_bounces_uptime": 0,
"last_counter_reset_str": "Mon May 18 04:44:43 2020 GMT",
"generated_bounce_recipients_reset": 0,
"deleted_recipients_reset": 0,
"messages_received_lifetime": 1312025,
"soft_bounced_events_uptime": 0,
"recipients_received_reset": 0,
"filter_hard_bounces_uptime": 0,
"expired_hard_bounces_lifetime": 0,
"recipients_received_lifetime": 1312025,
"total_hard_bounces_lifetime": 0,
"dk_signed_reset": 0,
"filter_hard_bounces_lifetime": 0,
"soft_bounced_events_lifetime": 0,
"dropped_messages_lifetime": 847,
"outstanding_requests": 0,
"cache_hits_lifetime": 1298528,
"generated_bounce_recipients_lifetime": 0,
"cache_misses_uptime": 7,
"soft_bounced_events_reset": 0,
"global_unsub_hits_lifetime": 0,
"total_completed_recipients_reset": 0,
"messages_received_reset": 0,
"expired_uptime": 5,
"five_xx_hard_bounces_reset": 0,
"dns_hard_bounces_lifetime": 0,
"expired_reset": 0,
"exceptions_uptime": 862787
}
]
},
"delivery_status_detail": []
}
}