Skip to main content
GET
/
health
Liveness check
curl --request GET \
  --url https://api.prefetch.io/health
{
  "status": "ok"
}

Documentation Index

Fetch the complete documentation index at: https://prefetch.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Overview

/health is a lightweight liveness probe. It returns HTTP 200 as long as the server process is alive, with no other checks performed. Use this endpoint to:
  • Verify the API server is up
  • Configure liveness probes in Kubernetes or other container orchestration systems
  • Check if a specific worker/instance is running
No API key is required.

Example request

curl https://api.prefetch.io/health

Example response

{
  "status": "ok"
}

Liveness vs readiness

EndpointChecksUse case
/healthServer process is aliveLiveness probe — restart if this fails
/readyServer + Redis connectivityReadiness probe — remove from load balancer if this fails
For production deployments, configure both /health (liveness) and /ready (readiness) probes so your orchestration system can make informed routing decisions.

Response

200 - application/json

Server is alive.

status
enum<string>
Available options:
ok
Example:

"ok"