Health Check

Check the health status of critical application dependencies including database and cache.

GET /health

Try it

Health Check

cURL

curl --request GET \
  --url https://app.formbricks.com/api/v2/health \
  --header 'x-api-key: <api-key>'

200

{
  "main_database": true,
  "cache_database": true
}

Authorizations

x-api-key · string · header · required

Use your Formbricks x-api-key to authenticate.

Response

200 - application/json

Health check completed successfully. Check individual dependency status in response data.

Health check status for critical application dependencies

main_database · boolean

Main database connection status - true if database is reachable and running

Example:

true

cache_database · boolean

Cache database connection status - true if cache database is reachable and running

Example:

true