Skip to main content
Use this endpoint to verify that the Harmstack API is up and accepting requests. No authentication is required, making it a safe first call to confirm connectivity before sending authenticated requests.

​
Endpoint

GET https://api.harmstack.com/v0/health

​
Request

No parameters or headers required. 
curl https://api.harmstack.com/v0/health

​
Response

Returns 200 OK with a JSON body confirming the service status.
​
status
string
required
The health status of the API. Always "ok" when the service is running normally.
{
  "status": "ok"
}
Call this endpoint before your first authenticated request to confirm that the API is reachable from your environment.