Skip to navigation

Create a backup global configuration

View as MarkdownOpen in Claude

Creates a backup global configuration: a named schedule you then assign to websites. Creating it backs nothing up yet: assign websites with “Assign websites to a backup global configuration”.

The technical batch sizes of a backup are not part of this API: a new configuration takes safe values.

Body

  • name (string, required): the configuration’s name, at most 255 characters.
  • region (string, required): where the backups are stored: eu-west-1, us-east-1 or ap-southeast-1.
  • schedule (object, required): when backups run.
    • frequency (daily, weekly or monthly, required): your plan decides which are available.
    • start_hour (HH:MM, required): 24 hours.
    • timezone (string, required): IANA name, for example Europe/Madrid.
    • day_week (monday to sunday, required for a weekly schedule and for a daily one with incremental backups, refused otherwise).
    • day_month (integer from 1 to 31, required for a monthly schedule, refused otherwise).
  • retention_period (integer, required): days each backup is kept: 3, 7, 14, 30, 45, 60 or 90. The frequency and your plan decide which values are accepted.
  • incremental (boolean, optional): daily schedules only; the weekly full backup runs on day_week.
  • exclusion (object, optional):
    • extensions (array of strings, optional): file extensions left out of every backup.
    • max_file_size (integer or null, optional): bytes, 104857600 to 1073741824, or null for no limit.
  • default (boolean, optional): true makes it the configuration new websites receive.

Errors

  • 422: batch is sent.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
defaultbooleanOptional
exclusionobjectOptional
namestringOptional
regionstringOptional
retention_perioddoubleOptional
scheduleobjectOptional

Response headers

LocationstringOptional

Response

201 - Backup configuration created

dataobjectOptional
jsonapiobjectOptional