Get on-disk backup state
Read on-disk backup config state.
GET
/api/v1/servers/{id}/backup-stateAuthorization
tse_sessionAPI key · cookierequiredPath parameters
idstringrequiredResponses
200
OK
errorstringreachablebooleanrequiredserver_idstringrequiredstanzasServerStanzaBackupState[]requiredShow propertiesHide properties
Array of
ServerStanzaBackupStatecronsCronJobParsed[]requiredShow propertiesHide properties
Array of
CronJobParseddaystringrequireddowstringrequiredfilestringrequiredhourstringrequiredminutestringrequiredmonthstringrequiredrepointeger<int64>rolestringstanzastringrequiredtypestringrequirednamestringrequiredreposPgbackrestRepoConf[]requiredShow propertiesHide properties
Array of
PgbackrestRepoConfhoststringhost_userstringpathstringrepo_indexinteger<int64>requiredretention_fullinteger<int64>retention_full_typestringtypestringdefault
Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message