Get pgBackRest health
Runs pgbackrest info for the stanza of the service. When the service has no active backup repo, it runs nothing and returns not_applicable. When the service is not running and no deploy of it completed (also when the first deploy failed), it runs nothing and returns not_deployed with the error “The service is not deployed yet”. first_backup_pending tells that no backups is expected: the first backup runs, or an operation whose end starts a full backup runs or ended less than 15 minutes ago.
/api/v1/database-services/{id}/health/pgbackresttse_sessionAPI key · cookierequiredidstringrequiredOK
backup_runningbooleanrequiredbackupsPgbackrestBackupInfo[]Show propertiesHide properties
PgbackrestBackupInfochecksum_errorsbooleanTrue when pgBackRest found invalid page checksums in the backup: some data files of the database are corrupt
database_idinteger<int64>database_size_bytesinteger<int64>requiredlabelstringrequiredolderbooleanTrue for a backup of a database id older than the newest of its repo, from before a PostgreSQL major upgrade. It restores only into a new service on pg_version, never in place
pg_versionstringprior_checksum_errorsbooleanTrue when a backup that this backup depends on (its full, and the diff of an incr) has invalid page checksums. A restore of this backup restores the corrupt files of that backup too, so it is refused like a backup with checksum_errors
repointeger<int64>size_bytesinteger<int64>requiredBytes that this backup stored in the repo, after compression. The files of the backups that it depends on are not included
start_timestringrequiredstop_timestringrequiredtypestringrequiredwal_startstringwal_stopstringcoverageStanzaCoverageJSONShow propertiesHide properties
assumes_archivingbooleanrequiredearlieststringrequiredendstringrequirednowstringrequiredreposRepoCoverageJSON[]requiredShow propertiesHide properties
RepoCoverageJSONbackupsCoveredBackupJSON[]requiredShow propertiesHide properties
CoveredBackupJSONchecksum_errorsbooleanTrue when pgBackRest found invalid page checksums in the backup, or in a backup that it depends on (its full, and the diff of an incr). A restore of it is refused unless allow_checksum_errors is set
labelstringrequiredstop_timestringrequiredcurrent_tliinteger<int32>requireddatabase_idinteger<int64>The pgBackRest database id of this coverage
earlieststringrequiredgrant_fingerprintstringThe license grant fingerprint of a fork or recover that restores this database id: the cluster that the copy has. Only a live scan of the backups gives it
kindstringrequiredlocalremoteolderbooleanTrue for a database id older than the newest of the stanza, from before a PostgreSQL major upgrade. Its times restore only into a new service on pg_version, and its coverage ends at its newest backup
pg_versionstringThe PostgreSQL major of the database id
repointeger<int64>requiredwal_maxstringrequiredwal_minstringrequirederrorstringfirst_backup_pendingbooleanTrue when the service has no backups only because its first backup did not end yet: the backup runs, or an operation whose end starts a full backup (a deploy, a restore, a major upgrade step) runs or ended less than 15 minutes ago on the console clock. The service health counts no backups as healthy then.
stanzastringstatusstringrequirednot_applicable: the service has no active backup repo. not_deployed: the service is not running and no deploy of it completed, so pgbackrest info did not run.
healthywarningerrornot_applicablenot_deployedwal_maxstringwal_minstringError
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message