---
title: "Get database health report."
method: GET
path: "/v4/db/{uid}/health"
tags: ["Database"]
---

# Get database health report.

`GET /v4/db/{uid}/health`

Database health check indication.

## Path parameters

- `uid` string, required

## Query parameters

- `issues_only` boolean

## Response `200`

Database report is ready see detailed information.

- DatabaseHealthReport
  - `active_active` ActiveActive
    - `available` boolean, required — Whether every replication link is up
    - `participating_clusters` Source[], required
      - `fqdn` string, required — fqdn of the cluster
      - `replica_id` string, required
      - `replication` 'down' | 'warning' | 'up', required — replication status of replica
  - `active_alerts` Alert[], required — List of active alerts for the database
    - `active_since` string, date-time, required — Since what time the alert is active
    - `name` string, required — Alert name
    - `severity` string — Severity level of the alert
    - `threshold` string — Threshold for the alert
  - `availability` 'down' | 'up', required — The replication link status
  - `availability_errors` string[] — List of errors that caused the BDB to be unavailable
  - `creation_time` string, date-time, required — Database creation time.
  - `detailed_status` 'active' | 'active-change-pending' | 'pending' | 'import-pending' | 'delete-pending' | 'recovery' | 'creation-failed' | 'unknown', required — The database detailed status
  - `endpoints` Endpoint[], required — Database endpoints.
    - `availability` 'down' | 'up', required — The replication link status
    - `name` string, required — Endpoint name
  - `high_availability` HighAvailability, required
    - `status` 'down' | 'up' | 'disabled', required — The high availability status
  - `id` string, required — Database id
  - `last_backup_time` string, date-time, nullable — Database last backup time.
  - `last_configured_time` string, date-time, required — Database last configuration time.
  - `name` string, required — Database name
  - `persistence` 'disabled' | 'aof' | 'rdb', required — Database persistence type.
  - `shards` ShardHealthReport[], required — Database shards.
    - `detailed_status` 'ok' | 'importing' | 'timeout' | 'loading' | 'busy' | 'down' | 'trimming' | 'unknown' | 'role_mismatch', required — shard detailed status
    - `id` string, required
    - `role` 'leader' | 'follower', required — shard role can be leader or follower
    - `status` 'active' | 'inactive' | 'trimming', required — shard status can be up or trimming
  - `shards_placement` 'dense' | 'sparse', required — Database shards placement.
  - `state_machine` StateMachine — State machine information
    - `name` string, required — State machine name
    - `state` string, required — State machine state
  - `status` 'active' | 'warning' | 'down', required — Database status
  - `version` string, required — Database version.

## Other responses

- `404` — Not Found
- `503` — Service Unavailable

---

[API](https://skmtc.net/redis/apis/redis-software-rest-api.md) · [All operations](https://skmtc.net/redis/apis/redis-software-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/redis/redis-software-rest-api/versions/c85fee8cf0f6/schema)