Free API Health Check - Uptime Monitoring

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/health" \
  -H "X-API-Key: YOUR_API_KEY"

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

$ch = curl_init("https://apixies.io/api/v1/health");
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/health",
    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 when the API is answering requests.

example response 200

{
    "status": "success",
    "http_code": 200,
    "code": "HEALTH_OK",
    "message": "API is healthy.",
    "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

Uptime monitoring integration

Use the health endpoint as a target for uptime monitoring services. Get instant alerts when the API becomes unavailable.

Load balancer health checks

Configure your load balancer to poll the health endpoint and route traffic only to healthy API instances.

Status page integration

Feed health check results into your public status page to keep users informed about API availability.

related endpoints

GET Readiness Check Check if the API is ready to accept requests by verifying database and cache connections 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