Create backup configuration | Modular DS

curl -X POST https://api.modulards.com/api/public/v1/preset-backups \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "default": false,
  "exclusion": {
    "extensions": [
      "zip",
      "log"
    ],
    "max_file_size": 209715200
  },
  "name": "Nightly",
  "region": "eu-west-1",
  "retention_period": 30,
  "schedule": {
    "frequency": "daily",
    "start_hour": "03:00",
    "timezone": "Europe/Madrid"
  }
}'

{
  "data": {
    "attributes": {
      "created_at": "2026-09-17T09:12:44.000000Z",
      "exclusion": {
        "extensions": [
          "zip",
          "log"
        ],
        "max_file_size": 209715200
      },
      "incremental": false,
      "is_default": false,
      "name": "Nightly",
      "region": "eu-west-1",
      "retention_period": 30,
      "schedule": {
        "day_month": null,
        "day_week": null,
        "frequency": "daily",
        "start_hour": "03:00",
        "timezone": "Europe/Madrid"
      },
      "status": "enabled",
      "updated_at": "2026-09-17T09:12:44.000000Z"
    },
    "id": "12",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/preset-backups/12"
    },
    "type": "preset-backups"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Creates a backup global configuration: a named schedule you then assign to websites. Answers 201 with the configuration document and a Location header. Creating it backs nothing up yet - assign websites with “Assign websites to a backup configuration”.

Body (JSON):

name (string, required, max 255).
region (string, required) - where the copies are stored: eu-west-1, us-east-1, ap-southeast-1.
schedule (object, required): frequency (daily, weekly, monthly - your plan decides which are available), start_hour (HH:MM, 24 hours), timezone (IANA name, e.g. Europe/Madrid), day_week (monday … sunday; required for a weekly schedule and for a daily one with incremental copies, refused otherwise), day_month (1-31; required for a monthly schedule, refused otherwise).
retention_period (integer, required) - days each copy 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 copy runs on day_week.
exclusion (object, optional): extensions (array of file extensions left out of every copy), max_file_size (bytes, 104857600 to 1073741824, or null for no limit).
default (boolean, optional) - true makes it the configuration new websites receive.

The technical batch sizes of a copy are not part of this API: a new configuration takes safe values and sending batch answers 422.

Requires a full-access token (read-only tokens answer 403). Validation failures answer 422 with a JSON:API errors document.

Creates a backup global configuration: a named schedule you then assign to websites. Answers **201** with the configuration document and a `Location` header. Creating it backs nothing up yet - assign websites with "Assign websites to a backup configuration". **Body** (JSON): - `name` (string, required, max 255). - `region` (string, required) - where the copies are stored: `eu-west-1`, `us-east-1`, `ap-southeast-1`. - `schedule` (object, required): `frequency` (`daily`, `weekly`, `monthly` - your plan decides which are available), `start_hour` (`HH:MM`, 24 hours), `timezone` (IANA name, e.g. `Europe/Madrid`), `day_week` (`monday` ... `sunday`; required for a weekly schedule and for a daily one with incremental copies, refused otherwise), `day_month` (1-31; required for a monthly schedule, refused otherwise). - `retention_period` (integer, required) - days each copy 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 copy runs on `day_week`. - `exclusion` (object, optional): `extensions` (array of file extensions left out of every copy), `max_file_size` (bytes, 104857600 to 1073741824, or null for no limit). - `default` (boolean, optional) - `true` makes it the configuration new websites receive. The technical batch sizes of a copy are not part of this API: a new configuration takes safe values and sending `batch` answers 422. Requires a full-access token (read-only tokens answer 403). Validation failures answer 422 with a JSON:API `errors` document.

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

Body (JSON):

name (string, required, max 255).
region (string, required) - where the copies are stored: eu-west-1, us-east-1, ap-southeast-1.
schedule (object, required): frequency (daily, weekly, monthly - your plan decides which are available), start_hour (HH:MM, 24 hours), timezone (IANA name, e.g. Europe/Madrid), day_week (monday … sunday; required for a weekly schedule and for a daily one with incremental copies, refused otherwise), day_month (1-31; required for a monthly schedule, refused otherwise).
retention_period (integer, required) - days each copy 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 copy runs on day_week.
exclusion (object, optional): extensions (array of file extensions left out of every copy), max_file_size (bytes, 104857600 to 1073741824, or null for no limit).
default (boolean, optional) - true makes it the configuration new websites receive.

The technical batch sizes of a copy are not part of this API: a new configuration takes safe values and sending batch answers 422.

Requires a full-access token (read-only tokens answer 403). Validation failures answer 422 with a JSON:API errors document.