Health Check Service

Overview

The Summon Search API contains a service for capturing the health status of the Search cluster. This provides a way to get the immediate status of the search system without pinging the Search API directly.


URL

The URL for the Health Check Service is http://api.summon.serialssolutions.com/2.0.0/search/ping


Headers

Because the Health Check Service is apart of the Search API, the authentication headers will be required with each call to the Health Check Service

Output Formats

The output of this service provides the same options available configurable in the authentication headers: XML and JSON.

Example - A basic XML Availability API response

<?xml version="1.0" encoding="UTF-8"?>
<response>
   <status>available</status>
</response>

Example - A basic JSON Availability API response

{
    "status": "available"
}