Health

The API exposes several health check endpoints. These are useful if you’re building health-aware integrations or want to verify the service is operational.

Health endpoints do not require authentication. No x-api-key header is needed.

Basic Health Check

`GET /health`

Returns basic service status.

{
  "status": "healthy",
  "service": "LinkedIn Scraper API",
  "version": "1.0.0",
  "environment": "production",
  "timestamp": "2026-08-11T12:00:00.000000+00:00",
  "request_id": "abc-123"
}

`GET /health/live`

Lightweight liveness probe. Returns 200 if the process is running.

{
  "status": "alive"
}

Readiness Probe

`GET /health/ready`

Checks whether the service and its dependencies are ready to handle requests. Returns 200 if ready, 503 if degraded or starting.

{
  "status": "ready",
  "checks": {
    "api": true,
    "redis": true,
    "linkedin": true
  },
  "errors": null,
  "timestamp": "2026-08-11T12:00:00.000000+00:00",
  "duration_ms": 42.5,
  "request_id": "abc-123"
}

Possible status values:

Status	HTTP Code	Meaning
`ready`	`200`	All checks passed
`degraded`	`503`	One or more checks failed
`starting`	`503`	Service is still initializing

Detailed Health Check

`GET /health/detailed`

Returns comprehensive health information including system metrics (memory, CPU) and dependency status. Query parameter:

Parameter	Type	Default	Description
`force_check`	boolean	`false`	Force fresh checks instead of cached results

The detailed endpoint includes service configuration and system resource usage. Use it for debugging, not for frequent polling.

When to use which endpoint

Endpoint	Use case
`/health/live`	Container liveness probe — “is the process alive?”
`/health/ready`	Load balancer / traffic routing — “can it handle requests?”
`/health`	Simple status check — “is it up?”
`/health/detailed`	Debugging — “what’s the full system state?”

Guides

API Reference

Health

Health

Basic Health Check

`GET /health`

`GET /health/live`

Readiness Probe

`GET /health/ready`

Detailed Health Check

`GET /health/detailed`

When to use which endpoint

​Health

​Basic Health Check

​GET /health

​GET /health/live

​Readiness Probe

​GET /health/ready

​Detailed Health Check

​GET /health/detailed

​When to use which endpoint

Health

Basic Health Check

`GET /health`

`GET /health/live`

Readiness Probe

`GET /health/ready`

Detailed Health Check

`GET /health/detailed`

When to use which endpoint