Health check

The health check tells monitors whether the API is up. It needs no token and deliberately carries no version prefix.

Every endpoint below shows its parameters and response fields in the middle and a request sample with an example response on the right.

Base URL https://api.sally.ioVersion v1.0 current, not frozen yetHow versioning works

Liveness check of the Public API

GET/healthNo authentication

Lightweight liveness/health probe for monitoring and uptime checks (e.g. a load balancer or status page). Requires NO authentication (no Bearer token) and reads no tenant data and no database — it only confirms that the API process is up and answering, and reports which service/environment/version responded.

Field overview from the specification

Response fields:

• status (string): health status; always ok when the service answers.
• service (string): name of the service that responded.
• environment (string): environment the service runs in (e.g. dev, prod).
• version (string): version of the running service.
• timestamp (string): time the response was produced (UTC ISO-8601).

Possible outcomes:

• 200: the service is running (body as above). This endpoint itself only ever returns 200 when reached.
• no response / 502 / 503 / 504: returned by the gateway/infrastructure, NOT by this endpoint, when the service is down, still starting, or unreachable — a missing or non-2xx answer is exactly the "unhealthy" signal a liveness probe checks for.

Response

• statusstringrequired

  Health status of the service; ok when it is running.

  Example: ok
• servicestringrequired

  Name of the service that answered.

• environmentstringrequired

  Environment the service runs in (e.g. dev, prod).

• versionstringrequired

  Version of the running service.

• timestampstringrequired

  Time the response was produced (UTC ISO-8601).

Status codes

• 200Service is running.

Request

cURL

curl "https://api.sally.io/health"

JavaScript

const response = await fetch(`https://api.sally.io/health`);
const data = await response.json();

Python

import requests

response = requests.get(
    f"https://api.sally.io/health",
)
data = response.json()

Response example 200 OK

{
  "status": "ok",
  "service": "string",
  "environment": "string",
  "version": "string",
  "timestamp": "string"
}