Skip to content
Bloomfilter Bloomfilter

Health check

GET
/health

Returns the current health status of the API and its dependent services.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

API is healthy or degraded

object
status
required
string
Allowed values: ok degraded error
uptime
required

Server uptime in seconds

number
version
required

API version string

string
timestamp
required

Current server timestamp in ISO 8601 format

string format: date-time
services
required
object
database
required
object
status
required
string
Allowed values: connected disconnected
latencyMs
required

Latency in milliseconds

number
redis
required
object
status
required
string
Allowed values: connected disconnected
latencyMs
required

Latency in milliseconds

number
registrar
required
object
status
required
string
Allowed values: connected disconnected
latencyMs
required

Latency in milliseconds

number

503

Section titled “503 ”

API is in error state

object
status
required
string
Allowed values: ok degraded error
uptime
required

Server uptime in seconds

number
version
required

API version string

string
timestamp
required

Current server timestamp in ISO 8601 format

string format: date-time
services
required
object
database
required
object
status
required
string
Allowed values: connected disconnected
latencyMs
required

Latency in milliseconds

number
redis
required
object
status
required
string
Allowed values: connected disconnected
latencyMs
required

Latency in milliseconds

number
registrar
required
object
status
required
string
Allowed values: connected disconnected
latencyMs
required

Latency in milliseconds

number