Public & system API

Health check

Liveness probe for load balancers and uptime monitors.

GET

https://api.screamingdata.dev/health

Authentication: None
Cost: Free
Body: No request body

Overview

Always returns 200 while the API process is alive; status is degraded when the database does not answer. queue and rate_limits are kept for older clients and are always empty. The body is not wrapped in the response envelope.

Cost

Free.

Request

GET /health.

This endpoint takes no parameters.

Request example

This endpoint does not need credentials.

curl --request GET \
  --url "https://api.screamingdata.dev/health"

import requests

response = requests.get(
    "https://api.screamingdata.dev/health",
    timeout=30,
)
print(response.status_code, response.json())

const response = await fetch("https://api.screamingdata.dev/health");
console.log(response.status, await response.json());

Response

HTTP 200. The body is plain JSON (not wrapped in the response envelope).

Response example

{
  "status": "ok",
  "database": true,
  "queue": {},
  "rate_limits": {}
}

Result fields

Liveness report. Not wrapped in the response envelope.

status

string

ok, or degraded when the database cannot be reached.

database

boolean

Whether the database answered.

queue

object

Kept for older clients; always empty.

rate_limits

object

Kept for older clients; always empty.

HTTP status codes

200The process is alive; check status for dependencies.

GETreadyReadiness checkReadiness probe: the database is reachable and migrations are applied.

Overview#

Request#

Request example#

Response#

Result fields#

HTTP status codes#

Related endpoints#