Using the Health Check URL

The health check URL is a means to get information about the Faspex server without having to provide credentials to the server. This information can then be passed on to other services like load balancers. The information is returned in a JSON response with whether the license on the server is valid and the statuses of the nodes on the server.

To use the health check URL, use the following curl command:

$ curl -k https://10.0.0.1/aspera/faspex/health_check

For example:

$ curl -k https:///aspera/faspex/health_check
{
  "valid_license" : true,
  "nodes" : [
    {
      "id": 1,
      "status": "Active",
      "contains_default_share": true
    },
    {
      "id": @,
      "status": "Error",
      "contains_default_share": false
    }
  ]
}