REredis
Database

Get database health report.

Changed on

Database health check indication.

get/v4/db/{uid}/health

Request

  • Base URL
    https://localhost:9443
  • URL
    https://localhost:9443/v4/db/{uid}/health
  • Auth
    API key in header r-auth-user

Path parameters

uidstring required

database ID

Query parameters

issues_onlyboolean

indicate to return only resources with unhealthy status

Response

Database report is ready see detailed information.

availability'down' | 'up' required

The replication link status

availability_errorsstring[]

List of errors that caused the BDB to be unavailable

creation_timestring 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

idstring required

Database id

last_backup_timestring date-time nullable

Database last backup time.

last_configured_timestring date-time required

Database last configuration time.

namestring required

Database name

persistence'disabled' | 'aof' | 'rdb' required

Database persistence type.

shards_placement'dense' | 'sparse' required

Database shards placement.

status'active' | 'warning' | 'down' required

Database status

versionstring required

Database version.

Changes

  • 7bc7a18e3b20Revision changes
    • warning

      added the new role_mismatch enum value to the // response property for the response status

    • info

      added the optional property to the response with the status

  • 9fdf3bc7ad77Revision changes
    • breaking

      api path removed without deprecation