GET /health

Health Check

Check if the API is operational and get basic status information.

Endpoint

GET https://api.robotdomainsearch.com/health

Parameters

None.

Request

curl "https://api.robotdomainsearch.com/health"

Response

{
  "status": "ok",
  "version": "0.2.0",
  "tlds": 511,
  "cacheStats": {
    "size": 42
  }
}

Response Fields

Field	Type	Description
status	string	API status (ok when healthy)
version	string	API version
tlds	number	Number of supported TLDs
cacheStats	object	Cache statistics
cacheStats.size	number	Number of cached domain results

Code Examples

curl

curl "https://api.robotdomainsearch.com/health"

Python

import requests

response = requests.get("https://api.robotdomainsearch.com/health")
data = response.json()

print(f"Status: {data['status']}")
print(f"Version: {data['version']}")
print(f"Supported TLDs: {data['tlds']}")
print(f"Cache size: {data['cacheStats']['size']}")

JavaScript

const response = await fetch("https://api.robotdomainsearch.com/health");
const data = await response.json();

console.log(`Status: ${data.status}`);
console.log(`Version: ${data.version}`);
console.log(`Supported TLDs: ${data.tlds}`);
console.log(`Cache size: ${data.cacheStats.size}`);

Use Cases

• Monitoring: Include in uptime checks and alerting
• Health probes: Use as Kubernetes/Docker health check endpoint
• Debugging: Verify API connectivity and version
• Discovery: Get count of supported TLDs

Notes

• This endpoint has no rate limiting
• Returns quickly without performing any backend checks
• Useful for load balancer health checks

📄 Raw markdown: /docs/api/health.md