Free Readiness Probe - DB & Cache Check

Parameters

This endpoint doesn't take any parameters.

Request

Send your key in the X-API-Key header. More languages and patterns live on the code examples page.

curl -s "https://apixies.io/api/v1/ready" \
  -H "X-API-Key: YOUR_API_KEY"

const res = await fetch("https://apixies.io/api/v1/ready", {
  headers: { "X-API-Key": "YOUR_API_KEY" }
});
const data = await res.json();
console.log(data);

$ch = curl_init("https://apixies.io/api/v1/ready");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["X-API-Key: YOUR_API_KEY"],
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($data);

import requests

res = requests.get(
    "https://apixies.io/api/v1/ready",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
print(res.json())

Response

The result sits under data in the standard envelope. See the response format guide for errors and status codes.

returns

data.status: Reads up once the database and cache both respond.

example response 200

{
    "status": "success",
    "http_code": 200,
    "code": "READY",
    "message": "API is ready",
    "data": {
        "status": "up"
    }
}

Authentication and limits

This endpoint needs an API key. Use the sandbox ("try it" above) to test it without registering. See the authentication guide for details.

Standard rate limits apply to this endpoint.

Common use cases

Kubernetes readiness probes

Use as a Kubernetes readiness probe to ensure pods only receive traffic after database and cache connections are established.

Deployment verification

Check the readiness endpoint after deployments to verify that all dependencies are connected before routing production traffic.

Dependency monitoring

Monitor the readiness of downstream services. Detect database or cache outages before they impact end users.

related endpoints

GET Health Check Check the health status of the API GET Test Endpoint Simple endpoint for testing API connectivity and authentication GET SSL Health Inspector Inspect SSL certificate details for a domain, including validity, expiry and chain health

getting started

authentication code examples response format

explore

all api endpoints guides and tutorials online tools

resources

homepage changelog suggest an endpoint

Get a free API key

A temporary key takes one click and no signup. Register and you get 75 requests/day. Free tier is for development & small projects.

get a temporary key create an account