Skip to main content
GET
/
health
Status & Health
curl --request GET \
  --url https://api.example.com/health
{
  "200": {},
  "500": {},
  "503": {},
  "name": "<string>",
  "version": "<string>",
  "status": "<string>",
  "docs": "<string>",
  "health": "<string>",
  "message": "<string>"
}

Overview

These endpoints provide system information and health checks for the Dependify API.

API Information

Get API Info

curl https://api.dependify.dev/
Response:
name
string
API name: "Dependify API"
version
string
Current API version (e.g., "2.0.0")
status
string
API status: "running"
docs
string
Path to interactive API documentation: "/docs"
health
string
Path to health check endpoint: "/health"
Example Response:
{
  "name": "Dependify API",
  "version": "2.0.0",
  "status": "running",
  "docs": "/docs",
  "health": "/health"
}

Health Check

Check API Health

curl https://api.dependify.dev/health
Verifies that the API server is running and responding to requests. Use this endpoint for monitoring and health checks in production environments. Response:
status
string
Health status: "healthy" or "unhealthy"
version
string
Current API version
message
string
Human-readable status message
Example Response:
{
  "status": "healthy",
  "version": "2.0.0",
  "message": "Dependify API is running"
}

Use Cases

Monitoring Setup

Use the health check endpoint in your monitoring tools: Docker Healthcheck:
HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
  CMD curl -f http://localhost:5001/health || exit 1
Kubernetes Probe:
livenessProbe:
  httpGet:
    path: /health
    port: 5001
  initialDelaySeconds: 10
  periodSeconds: 30
  
readinessProbe:
  httpGet:
    path: /health
    port: 5001
  initialDelaySeconds: 5
  periodSeconds: 10

Version Checking

Check the API version to ensure compatibility:
const checkApiVersion = async () => {
  const response = await fetch('https://api.dependify.dev/');
  const info = await response.json();
  
  console.log(`API Version: ${info.version}`);
  
  if (info.version !== expectedVersion) {
    console.warn('API version mismatch - update your client');
  }
};

Service Discovery

Use the root endpoint to discover API documentation:
const discoverApi = async () => {
  const response = await fetch('https://api.dependify.dev/');
  const info = await response.json();
  
  // Open interactive documentation
  window.open(`https://api.dependify.dev${info.docs}`, '_blank');
};

Interactive Documentation

Dependify provides interactive API documentation powered by FastAPI:

Swagger UI

Access interactive Swagger documentation at:
https://api.dependify.dev/docs
Features:
  • Try API endpoints directly in the browser
  • View request/response schemas
  • Test authentication flows
  • Download OpenAPI specification

ReDoc

Access alternative ReDoc documentation at:
https://api.dependify.dev/redoc
Features:
  • Clean, readable documentation format
  • Search functionality
  • Code samples in multiple languages
  • Printable documentation

Status Codes

Both endpoints return standard HTTP status codes:
200
OK
API is healthy and responding normally
503
Service Unavailable
API is starting up or experiencing issues
500
Internal Server Error
API encountered an unexpected error

Build docs developers (and LLMs) love