Using the Health Check URL

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

Using the Health Check for Load Balancers

Use the health_check_lite endpoint for load balancers. The endpoint returns simply whether the server is running.

$ curl -k https://server_address/aspera/faspex/health_check_light

For example:

$ curl -k https://faspex.com/aspera/faspex/health_check_light
{
  "message" : "Faspex is running"
}

Using the Detailed Health Check

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/aspera/faspex/health_check

For example:

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

Important: The detailed health check is resource-intensive and should not be called too frequently as it may impact Faspex performance.

Detailed Health Response Codes

Code	Status
`HTTP 200`	Apache and Faspex services are healthy, the default node is healthy, and the Faspex license is valid.
`HTTP 503`	The Apache service is healthy, but the Faspex service is down.
`HTTP 500`	Apache and Faspex services are healthy, but either the default node is down or it has an invalid license. The JSON response reports the exact issue.