Readiness Check

Check if the API is ready to accept requests by verifying database and cache connections

GET


                    api/v1/ready

Check if the API is ready to accept requests by verifying database and cache connections

Rate Limiting

Standard rate limits apply to this endpoint.

Authentication

This endpoint requires authentication via API key. You can use the sandbox mode for testing without registering. See the authentication guide for details.

Response details for this API endpoint. See the response format guide for the standard response structure.

Example Response

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

Example Usage

Here's how to use this endpoint in various languages. For more examples, see our code examples page.

cURL

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

JavaScript

fetch("https://apixies.io/api/v1/ready", {
    method: "GET",
    headers: {
        "Content-Type": "application/json",
        "X-API-Key": "YOUR_API_KEY"
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));

PHP

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://apixies.io/api/v1/ready");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "X-API-Key: YOUR_API_KEY"
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Try It Yourself

Test this endpoint directly from your browser using our API sandbox. No authentication required for testing.

Try API Endpoint

This is a limited sandbox environment.

For higher limits (75 requests/day), register for a free account.

API Endpoint

/

Sandbox API Usage Get full API access

No token information available

Sandbox (no account): 50 requests per token, 1 token per day, 24-hour expiry

Your session has expired. A new token will be created automatically.

Your daily Sandbox API quota has been exhausted. Please try again tomorrow.

Need higher limits? Register for free and get 75 requests/day.

Unable to validate your API token.

Response

Send a request to see the response

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 API Endpoints

Explore related endpoints that work well with Readiness Check.

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

Share Your Feedback

Suggest a micro‑API