Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.smartretry.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

SmartRetry provides health check endpoints to monitor API availability. Use these endpoints for uptime monitoring, load balancer health checks, and integration testing.

​
Endpoints

EndpointPurpose
GET /health/Basic health check - returns 200 if the API is running
GET /health/readyReadiness check - returns 200 if the API can process requests
GET /health/liveLiveness check - returns 200 if the API process is alive
Health endpoints do not require authentication. They are designed for infrastructure monitoring.

​
Basic health check

Returns 200 OK if the API service is running. 
curl --request GET \
  --url https://api.smartretry.com/health/

{
  "status": "healthy",
  "timestamp": "2026-04-01T14:22:13Z"
}

​
Readiness check

Returns 200 OK when the API is ready to accept and process requests. This endpoint verifies that all dependencies (database, cache, downstream services) are available. Use this endpoint for:
  • Kubernetes readiness probes
  • Load balancer health checks
  • Pre-deployment verification
curl --request GET \
  --url https://api.smartretry.com/health/ready

{
  "status": "ready",
  "timestamp": "2026-04-01T14:22:13Z",
  "checks": {
    "database": "ok",
    "cache": "ok",
    "payment_providers": "ok"
  }
}

​
Liveness check

Returns 200 OK if the API process is running. This is a minimal check that doesn’t verify dependencies. Use this endpoint for:
  • Kubernetes liveness probes
  • Basic uptime monitoring
  • Restart triggers
curl --request GET \
  --url https://api.smartretry.com/health/live

{
  "status": "alive",
  "timestamp": "2026-04-01T14:22:13Z"
}

​
Using health checks

​
Kubernetes probes

Configure Kubernetes liveness and readiness probes to automatically restart unhealthy pods and route traffic only to ready instances: 
apiVersion: v1
kind: Pod
spec:
  containers:
    - name: app
      livenessProbe:
        httpGet:
          path: /health/live
          port: 443
          scheme: HTTPS
          host: api.smartretry.com
        initialDelaySeconds: 10
        periodSeconds: 30
      readinessProbe:
        httpGet:
          path: /health/ready
          port: 443
          scheme: HTTPS
          host: api.smartretry.com
        initialDelaySeconds: 5
        periodSeconds: 10

​
Uptime monitoring

Add health endpoints to your monitoring service (Datadog, New Relic, Pingdom, etc.) to receive alerts when SmartRetry is unavailable: 
# Example: Simple uptime monitor
import requests
import time

def check_health():
    try:
        response = requests.get(
            "https://api.smartretry.com/health/ready",
            timeout=5
        )
        return response.status_code == 200
    except requests.RequestException:
        return False

while True:
    if not check_health():
        send_alert("SmartRetry API is not ready")
    time.sleep(60)

​
Pre-request validation

Check API readiness before sending payment requests to fail fast: 
import requests

def process_payment(payment_data):
    # Check readiness first
    health = requests.get("https://api.smartretry.com/health/ready", timeout=2)
    if health.status_code != 200:
        raise Exception("SmartRetry API is not available")

    # Proceed with payment
    response = requests.post(
        "https://api.smartretry.com/v1/payments/sale/ABC123",
        headers={"x-api-key": "YOUR_API_KEY"},
        json=payment_data
    )
    return response.json()
For production monitoring, also subscribe to the SmartRetry status page for incident notifications and scheduled maintenance alerts.