Add a backup target
Opens the target and writes the marker .tse-backup-target into it, or keeps the marker that is there. Each backup checks the marker first. The console has at most one local target. The credentials of an s3 target are kept encrypted and never returned.
/api/v1/console-backup/targetstse_sessionAPI key · cookierequiredapplication/jsonkindstringrequiredlocal: the backup directory of the console host (TSE_BACKUP_DIR). s3: an S3-compatible bucket
locals3namestringrequiredsecretsBackupTargetSecretsBodyRequired for an s3 target
Show propertiesHide properties
s3S3BackupSecretsThe credentials of an s3 target. The console keeps them encrypted and never returns them
Show propertiesHide properties
access_key_idstringrequiredsecret_access_keystringrequiredsession_tokenstringsettingsBackupTargetSettingsBodyShow propertiesHide properties
s3S3BackupSettingsThe settings of an s3 target. A local target has no settings
Show propertiesHide properties
bucketstringrequiredca_bundlestringendpointstringpath_stylebooleanprefixstringregionstringOK
created_atstring<date-time>requiredidstringrequiredkindstringrequiredlocals3namestringrequiredsecrets_setbooleanrequiredThe target has stored credentials. The API never returns them
settingsBackupTargetSettingsBodyrequiredShow propertiesHide properties
s3S3BackupSettingsThe settings of an s3 target. A local target has no settings
Show propertiesHide properties
bucketstringrequiredca_bundlestringendpointstringpath_stylebooleanprefixstringregionstringupdated_atstring<date-time>requiredError
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message