Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.example.com/health
{
  "status": "<string>",
  "version": "<string>"
}
Returns the health status and version of the V1 API. This endpoint does not require authentication.

​
Request

curl -X GET "https://app.shipstar.ai/api/v1/health"

​
Response

​
status
string
required
API health status. Returns "healthy" when operational.
​
version
string
required
The API version string.

​
Example Response

200
{
  "status": "healthy",
  "version": "1.0.0"
}