Skip to content
Start free in Cloud

Get database resilience status REST API

GET
/api/admin/system/database
curl --request GET \
--url https://hitkeep.com/api/admin/system/database \
--cookie hk_token=<hk_token>

Returns sanitized recovery configuration, retained recovery history, and checkpoint state while the database is available. Live recovery state is reported through readiness and 503 responses.

System database status

Media typeapplication/json
object
automatic_wal_recovery_enabled
boolean
checkpoint_interval_min
integer
last_checkpoint_at
string format: date-time
last_checkpoint_error
string
last_recovery_at
string format: date-time
recovery_bundle_available
boolean
recovery_enabled
boolean
removed_unsafe_indexes
integer
Examplegenerated
{
"automatic_wal_recovery_enabled": true,
"checkpoint_interval_min": 1,
"last_checkpoint_at": "2026-04-15T12:00:00Z",
"last_checkpoint_error": "example",
"last_recovery_at": "2026-04-15T12:00:00Z",
"recovery_bundle_available": true,
"recovery_enabled": true,
"removed_unsafe_indexes": 1
}

Database recovery is in progress or requires operator attention

Media typeapplication/json
object
message
string
Examplegenerated
{
"message": "example"
}