Endpoint

GET https://api.merion.com.au/health

Authentication: None required
Purpose: Returns a simple JSON object confirming the API is accepting requests. Suitable for uptime monitoring and integration health checks.

Responses

Healthy — HTTP 200

When the API is operational, it returns HTTP 200 OK with the following body:

{"status": "ok"}

Degraded — HTTP 503 or network failure

If the API is unavailable, the request will fail at the network layer — no JSON body is returned. Your monitoring tool should treat any non-200 response, connection refusal, or timeout as a degraded state. Check status.merion.com.au for the current incident status.

Example

curl -s https://api.merion.com.au/health
# {"status":"ok"}

Polling guidance

Poll the health endpoint at most once per minute. More frequent polling is unnecessary — the endpoint reflects the API's accept/reject state, not granular internal component health. Polling more frequently than once per minute will be rate-limited.

For historical uptime and incident history, subscribe to the status page at status.merion.com.au. The status page provides email notifications for incidents and maintenance windows.

Integration recipe: pre-flight check

In critical integration workflows — such as a batch job that submits debt referrals overnight — check /health before sending payloads. If the health check returns non-200, queue the submissions for retry rather than showing the user an error or silently dropping data.

async function isApiHealthy(): Promise<boolean> {
  try {
    const res = await fetch("https://api.merion.com.au/health");
    if (!res.ok) return false;
    const body = await res.json();
    return body?.status === "ok";
  } catch {
    return false;
  }
}

// Before submitting a batch of forms:
if (!(await isApiHealthy())) {
  console.warn("Merion API is not healthy — deferring submission");
  // queue for retry
  return;
}

See Error Handling for guidance on retry strategies and Forms Intake Recipe for a full end-to-end submission example.

Uptime monitoring tools

The health endpoint is compatible with any HTTP uptime monitor. Configuration pointers:

UptimeRobot / Better Uptime / Pingdom: Add a new HTTP(S) monitor pointing to https://api.merion.com.au/health. Set the expected status code to 200. Optionally assert the response body contains "ok".
Check interval: 1–5 minutes is appropriate. Shorter intervals are unnecessary and will be rate-limited.
Alert threshold: Alert after 2–3 consecutive failures to reduce false positives from transient network blips.

Health Endpoint