Apply the backup config
Apply the backup configuration to the servers.
/api/v1/database-services/{id}/apply-backup-configtse_sessionAPI key · cookierequiredidstringrequiredAccepted
backupConfigOutOfSyncbooleanrequiredbackupNeedsAttentionbooleanrequiredbackupUnprotectedbooleanrequiredcreated_atstringrequireddata_dirstringrequireddatabase_namestringrequiredextension_versionsobjectrequiredThe stored version of each extension whose packages the deploy installs, by extension name. TimescaleDB is timescaledb_version too.
extensionsstring[]requiredhealthServiceHealthResponseThe stored health verdict of a running service. Absent before the first poll and when the service is not running.
Show propertiesHide properties
checked_atstring<date-time>The time of the last real reading. Absent when there is none. When it is 15 minutes old or older, status is error with a reason that names the checks that did not run.
componentsComponentHealthResponse[]requiredShow propertiesHide properties
ComponentHealthResponsekeystringrequiredThe stable key of the component: the path segment of its endpoint. Name is text for people and can change.
patronietcdpgbouncerhaproxypgbackrestpostgresqlreservevipmessagestringnamestringrequiredstatusstringrequiredhealthywarningerrorunknownnot_applicablereasonstringrequiredsincestring<date-time>The time the status last changed. Absent on a live reading.
statusstringrequiredhealthywarningerrorunknownidstringrequiredlicense_enforcedbooleanlivesync_targetbooleannamestringrequiredpack_releasestringrequiredThe release of the server packages that the PostgreSQL servers of the service install from, for example v0.11.0-eap.1. Empty when the service has no pin yet: its next deploy pins the newest loaded release that has its versions
pg_versionstringpg_version_minorstringpostgresql_existsbooleanrequiredredeploy_recommendedbooleanrequiredstatusstringrequiredtimescaledb_versionstringEmpty when unknown (a service from before TSE-734)
topologystringrequiredsingle_nodestandard_haadvanced_haupdates_availablebooleanrequiredThe Updates tab of the service lists items: the service runs, and its pinned server packages or a newer loaded release have newer versions, or the loaded server components are newer. Nothing changes until an operator runs Check and an admin runs Upgrade
Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message