Sign in
Database

Get database health report.

Database health check indication.

get/v4/db/{uid}/health

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

Changed in 2 of the 26 revisions of this API.111

  • 7bc7a18e3b2011See the full diff
    • ●

      added the new role_mismatch enum value to the shards/items/detailed_status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property availability_errors to the response with the 200 status

      response-optional-property-added

  • 9fdf3bc7ad771See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 43 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog