Skip to main content
GET
/
ready
Readiness check
curl --request GET \
  --url https://api.prefetch.io/ready
{
  "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

/ready is a readiness probe that checks whether the server is ready to handle requests. Unlike /health, it verifies that Redis is reachable — since the job queue requires Redis to function.
  • Returns 200 when the server is ready
  • Returns 503 when Redis is unavailable
No API key is required.

​
Example request

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

​
Example responses

200 - Ready
{
  "status": "ok"
}
503 - Not ready
{
  "status": "error",
  "message": "Redis connection failed"
}

​
When to use /ready

Use /ready as a readiness probe in your container orchestration system. When this endpoint returns a non-200 response:
  • Kubernetes — removes the pod from service endpoints until it recovers
  • Load balancers — stops routing traffic to the unhealthy instance
  • Health checks — triggers alerting for on-call engineers
Configure your readiness probe with a failure threshold of 2–3 before removing an instance from rotation. Brief Redis hiccups during deployments are normal.

Response

Server is ready.

​
status
enum<string>
Available options:
ok
Example:

"ok"