Create a backup global configuration
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-1orap-southeast-1.schedule(object, required): when backups run.frequency(daily,weeklyormonthly, required): your plan decides which are available.start_hour(HH:MM, required): 24 hours.timezone(string, required): IANA name, for exampleEurope/Madrid.day_week(mondaytosunday, 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 onday_week.exclusion(object, optional):extensions(array of strings, optional): file extensions left out of every backup.max_file_size(integer ornull, optional): bytes, 104857600 to 1073741824, ornullfor no limit.
default(boolean, optional):truemakes it the configuration new websites receive.
Errors
- 422:
batchis 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.
default
exclusion
name
region
retention_period
schedule
Response headers
Location
Response
201 - Backup configuration created
data
jsonapi
