Skip to navigation

Update a backup global configuration

View as MarkdownOpen in Claude

Updates one backup global configuration. Send only the fields you want to change.

  • schedule is replaced whole: when you send it, it carries every field it needs (frequency, start_hour, timezone and the day its frequency asks for); when you leave it out, the stored one stays.
  • The frequency, the retention and incremental are validated together, using the stored value of the ones you leave out.
  • A new schedule reaches every website that uses the configuration and reschedules their next backup. A new retention_period moves the expiry of the backups those websites already hold, so a shorter retention brings deletions forward.
  • default: true makes it the configuration new websites receive and takes the mark off the previous one; default: false clears it.
  • The technical batch sizes are not part of this API: the configuration keeps the ones it has.

Body

All fields are optional and take the same values as in “Create a backup global configuration”.

  • name (string, optional): the configuration’s name.
  • region (string, optional): where the backups are stored.
  • schedule (object, optional): frequency, start_hour, timezone and the day its frequency asks for.
  • retention_period (integer, optional): days each backup is kept.
  • incremental (boolean, optional): daily schedules only.
  • exclusion (object, optional): extensions and max_file_size.
  • default (boolean, optional): whether new websites receive it.

Errors

  • 422: retention_period is not allowed by the stored frequency, a weekly schedule is sent to a configuration that still has incremental on (send incremental: false with it), or batch is sent.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

preset_backupstringRequired

Request

This endpoint expects an object.
retention_perioddoubleOptional

Response

200 - Backup configuration updated

dataobjectOptional
jsonapiobjectOptional