{
  "id": "health_report",
  "title": "CRDB health report object",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/crdb/health_report/",
  "summary": "An object that represents an Active-Active database health report.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "children": [
    {
      "id": "health_report_configuration",
      "summary": "An object that represents the database configuration to include in an Active-Active database health report.",
      "title": "CRDB health report configuration object",
      "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/crdb/health_report/health_report_configuration/"
    }
  ],
  "page_type": "content",
  "content_hash": "636b23bcc077ce21e27fca84e781f5147fad72a0bab106072e098b099672a22b",
  "sections": [
    {
      "id": "content",
      "title": "Content",
      "role": "content",
      "text": "An object that represents an Active-Active database health report.\n\n| Name | Type/Value | Description |\n|------|------------|-------------|\n| active_config_version | integer | Active configuration version |\n| cluster_name | string | Name of local Active-Active cluster |\n| configurations | array of [health_report_configuration]() objects | Stored database configurations |\n| connection_error | string | Error string if remote cluster is not available |\n| connections | \n[{\n  \"name\": string,\n  \"replication_links\": [ \n    {\n      \"link_uid\": \"bdb_uid:replica_uid\", \n      \"status\": \"up | down\" \n    } ],\n  \"status\": string\n}, ...]  | Connections to other clusters and their statuses. A replication link's `bdb_uid` is the unique ID of a local database instance ([bdb]()) in the current cluster. The `replica_uid` is the unique ID of the database's remote replica, located in the connected cluster. |\n| name | string | Name of the Active-Active database |"
    }
  ],
  "examples": []
}
