System

Readiness check

Readiness probe, distinct from GET /health’s pure liveness check: when storage is Supabase-backed, this one actually queries Postgres (SELECT 1, no table rows transferred) so an orchestrator can tell a process that is up but backed by dead storage apart from one that is genuinely ready to serve traffic. When storage is not Supabase-backed (NODE_ENV=test, or PARMANA_STORAGE=memory outside test), there is no external dependency to probe, so this reports READY unconditionally. Exempt from caller authentication for the same reason GET /health is, see packages/api/src/routes/ready.ts.

GET

ready

Readiness check

curl --request GET \
  --url http://localhost:3000/ready

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/ready",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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 := "http://localhost:3000/ready"

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

	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("http://localhost:3000/ready")

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

request = Net::HTTP::Get.new(url)

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

{
  "status": "READY",
  "storage": "not-supabase-backed",
  "authDisabled": false
}

Response

Storage reachable, or not Supabase-backed.

Response returned by GET /ready on both status codes (200 READY, 503 NOT_READY). Distinct from GET /health's pure liveness check: when storage is Supabase-backed, this one actually queries Postgres (SELECT 1) so an orchestrator can route around a process that is up but backed by dead storage.

status

enum<string>

required

Available options:

READY,

NOT_READY

storage

enum<string>

Present only when status is READY and storage is not Supabase-backed (NODE_ENV=test, or PARMANA_STORAGE=memory outside test): there is no external dependency to probe, so readiness is reported unconditionally.

Available options:

not-supabase-backed

reason

string

Present only when status is NOT_READY: the underlying Postgres error message.

authDisabled

boolean

True when this process was started with PARMANA_AUTH_DISABLED=true. Surfaced here, not only as a startup log line, so an operator's own synthetic checks against GET /ready can alert on it directly.

warning

string

Present only when authDisabled is true.

Readiness check

curl --request GET \
  --url http://localhost:3000/ready

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/ready",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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 := "http://localhost:3000/ready"

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

	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("http://localhost:3000/ready")

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

request = Net::HTTP::Get.new(url)

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

{
  "status": "READY",
  "storage": "not-supabase-backed",
  "authDisabled": false
}

Get Started

Core Concepts

Guides

SDKs

REST API

Security & Deployment

Integrations

Tutorials

Advanced

Support

Changelog

Readiness check

Response