Skip to main content
GET
/
api
/
v1
/
pub
/
health
Health Check
curl --request GET \
  --url https://app.arahealth.io/api/v1/pub/health
{
  "message": "healthy"
}

​
Overview

Check if the API is running and healthy. This endpoint does not require authentication and can be used for monitoring and health checks.

​
Endpoint

GET https://app.arahealth.io/api/v1/pub/health
Base URL: https://app.arahealth.io Path: /api/v1/pub/health Method: GET Authentication: None required

​
Code Examples

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://app.arahealth.io/api/v1/pub/health");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

​
Response

A successful health check returns: 
{
  "message": "healthy"
}

​
Response Fields

  • message - Health status message (returns “healthy” when API is operational)

Response

200 - application/json

API is healthy

​
message
string

Health status message

Example:

"healthy"