Get Health

GET

health

Health check

curl --request GET \
  --url https://billing.example.com/health \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://billing.example.com/health', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/health"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "status": "ok",
  "version": "<string>",
  "components": {}
}

{
  "status": "ok",
  "version": "<string>",
  "components": {}
}

The liveness and readiness probe for a Recurso instance. It pings Postgres, pings Redis when the process connected to one at boot, and reports the boot-time TigerBeetle connection state, then rolls the two pings up into a single status. No authentication is required, and the response never includes the underlying error — component failures are logged server-side only, so a public probe cannot leak connection details. Point your uptime monitor at this endpoint (see Monitoring and Alerting). For the build identifier alone, use Get Version; for scrape-style telemetry, use Get Prometheus Metrics.

The HTTP status follows the system of record. Postgres down returns 503 with status: "degraded". Redis down (locking and rate-limit degrade, money paths still work) returns 200 with status: "degraded". A disconnected TigerBeetle (the Postgres ledger is authoritative; TigerBeetle is an optional accelerator) does not touch status at all — with Postgres and Redis up you get 200 and status: "ok" alongside components.tigerbeetle.status: "disconnected". Read components for the detail.

Example Request

curl https://api.recurso.dev/health

Response

Returned bare — no data envelope.

{
  "status": "ok",
  "version": "v0.14.0",
  "components": {
    "postgres": { "status": "up" },
    "redis": { "status": "up" },
    "tigerbeetle": { "status": "connected" }
  }
}

When Postgres is unreachable the same shape comes back with HTTP 503:

{
  "status": "degraded",
  "version": "v0.14.0",
  "components": {
    "postgres": { "status": "down" },
    "redis": { "status": "up" },
    "tigerbeetle": { "status": "disconnected" }
  }
}

Fields

Field	Type	Description
`status`	string	`ok` unless the Postgres or Redis ping fails, in which case `degraded`. TigerBeetle never affects this value — a disconnected TigerBeetle is reported only under `components`.
`version`	string	The running build version — the same value Get Version returns.
`components`	object	Per-component status, keyed by component name.
`components.postgres.status`	string	`up` or `down`. Down is critical: the response is `503`.
`components.redis.status`	string	`up` or `down`. Present only when Redis was connected at boot — `REDIS_URL` parsed and the boot-time ping succeeded. If `REDIS_URL` is set but unusable and `REQUIRE_REDIS` is not, the process falls back to in-memory and this key is absent. Down is degraded but serving.
`components.tigerbeetle.status`	string	`connected` or `disconnected` — the boot-time client state. Disconnected means PG-only ledger mode.

Errors

Status	Code	When	Fix
`503`	—	Postgres ping failed. The body is the health payload above with `status: "degraded"`, not an error envelope.	Check the database and `DATABASE_URL`; the process keeps serving so the probe can report recovery.

This endpoint does not use the error envelope — every response, including 503, is the health payload above.

Authorizations

Authorization

string

header

required

Response

Service is healthy (or degraded but serving).

status

enum<string>

Available options:

ok,

degraded

version

string

components

object

Show child attributes

Health check

curl --request GET \
  --url https://billing.example.com/health \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://billing.example.com/health', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/health"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/health")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "status": "ok",
  "version": "<string>",
  "components": {}
}

{
  "status": "ok",
  "version": "<string>",
  "components": {}
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Example Request

Response

Fields

Errors

Authorizations

Response

​Example Request

​Response

​Fields

​Errors

Authorizations

Response

Example Request

Response

Fields

Errors