Properties
| NAME | TYPE | DESCRIPTION |
health | string | Overall health status: healthy, degraded, unhealthy, or unknown when nothing could be measured. |
ready | boolean | Whether the database is ready to accept connections. |
engine | string | Database engine: postgresql, mysql, or mongodb. |
version | string | Database engine version. |
uptime | integer | Database uptime in seconds. |
connections | object | Connection statistics. |
syncMode | string | Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing. |
effectiveSyncMode | string | Replication sync mode the primary is actually enforcing. Null when high availability is disabled or the state could not be read. |
syncDegraded | boolean | Whether the enforced replication is weaker than the requested syncMode. |
syncAcknowledgements | integer | Number of standby acknowledgements the primary waits for before a write is committed. |
syncStandbyCount | integer | Number of standbys registered with the primary for synchronous replication. |
syncStateConfirmed | boolean | Whether the other sync fields are an engine reading rather than a recorded estimate. True when the primary answered what it is enforcing, including when that answer contradicted the record, in which case the contradicted values are replaced by the ones the engine reports. False when the reading could not be taken: the probe did not answer, there was no engine to ask, or the values describe a configuration change just applied rather than anything measured. Absent when no engine was asked at all, so an unprobed database is distinguishable from an unconfirmed one. False never means a standby was found lagging, because it is the absence of a reading rather than a negative one, so draw no conclusion about replication health from it or from a response that omits it. |
replicas | array | List of database replicas and their status. Every configured member appears, including one the backend has not brought up, which is reported as not healthy. Can be one of: |
volumes | array | Storage volume information. Can be one of: |
Example
{
"health": "healthy",
"ready": true,
"engine": "postgresql",
"version": "17",
"uptime": 86400,
"connections": {
"current": 12,
"max": 100
},
"syncMode": "async",
"effectiveSyncMode": "async",
"syncDegraded": false,
"syncAcknowledgements": 1,
"syncStandbyCount": 2,
"syncStateConfirmed": true,
"replicas": [
{
"index": 0,
"role": "primary",
"healthy": true,
"replicating": null,
"lagSeconds": null
},
{
"index": 1,
"role": "replica",
"healthy": true,
"replicating": true,
"lagSeconds": 0.2
}
],
"volumes": {
"data": {
"path": "/var/lib/postgresql/data",
"usedPercent": "45%",
"available": "55GB",
"mounted": true
}
}
}
{
"health": "healthy",
"ready": true,
"engine": "postgresql",
"version": "17",
"uptime": 86400,
"connections": {
"current": 12,
"max": 100
},
"syncMode": "async",
"effectiveSyncMode": "async",
"syncDegraded": false,
"syncAcknowledgements": 1,
"syncStandbyCount": 2,
"syncStateConfirmed": true,
"replicas": [
{
"index": 0,
"role": "primary",
"healthy": true,
"replicating": null,
"lagSeconds": null
},
{
"index": 1,
"role": "replica",
"healthy": true,
"replicating": true,
"lagSeconds": 0.2
}
],
"volumes": {
"data": {
"path": "/var/lib/postgresql/data",
"usedPercent": "45%",
"available": "55GB",
"mounted": true
}
}
}