Change a backup target
Changes the name, and the settings or the credentials of an s3 target. The kind does not change. New settings or credentials set up the marker again, in the new place.
/api/v1/console-backup/targets/{id}tse_sessionAPI key · cookierequiredidstringrequiredapplication/jsonnamestringrequiredsecretsBackupTargetSecretsBodyThe new credentials. Not set: the stored credentials do not change
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_tokenstringsettingsBackupTargetSettingsBodyThe new settings. Not set: the settings do not change
Show 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