Using the Health Check URL

Edit online

Use the health check URL to check the Shares server status without providing credentials to the server. You can pass on the response to other services like load balancers.

Using the Health Check URL

The standard health check returns a JSON response with the validity of the server license and the statuses of the nodes on the server.

$ curl -k https://server_address/health_check

For example:

$ curl -k https://10.0.0.1/health_check
{
  "valid_license" : true,
  "nodes" : [
    {
      "id": 1,
      "status": "Active",
    },
    {
      "id": 2,
      "status": "Error",
    }
    {
      "id": 3,
      "status": "Disabled",
    }
  ]
}

Response Codes

Code	Status
`HTTP 200`	Shares nodes are healthy and the Shares license is valid.
`HTTP 500`	Either Shares has an invalid license, or one of the Share nodes are down. The JSON response reports the exact issue.