Update backup configuration | Modular DS

curl -X PATCH https://api.modulards.com/api/public/v1/preset-backups/preset_backup \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "retention_period": 14
}'

{
  "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": 14,
      "schedule": {
        "day_month": null,
        "day_week": null,
        "frequency": "daily",
        "start_hour": "03:00",
        "timezone": "Europe/Madrid"
      },
      "status": "enabled",
      "updated_at": "2026-09-17T10:03:10.000000Z"
    },
    "id": "12",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/preset-backups/12"
    },
    "type": "preset-backups"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Edits one backup global configuration. Send only what changes; answers 200 with the configuration document.

Body (JSON), every field optional: name, region, schedule, retention_period, incremental, exclusion, default - the same fields and values as “Create backup configuration”.

schedule is replaced whole: when it is sent it carries every field it needs (frequency, start_hour, timezone and the day its frequency asks for); when it is left out the stored one stays.
The frequency, the retention and incremental are validated together, with the stored value of the ones you leave out. A retention_period the stored frequency does not allow answers 422, and so does a weekly schedule sent to a configuration that still has incremental on: send incremental: false with it.
A new schedule reaches every website that uses the configuration and reschedules their next copy. A new retention_period moves the expiry of the copies 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 and sending batch answers 422.

Requires a full-access token (read-only tokens answer 403). A configuration of another organization answers 404.

Edits one backup global configuration. Send only what changes; answers **200** with the configuration document. **Body** (JSON), every field optional: `name`, `region`, `schedule`, `retention_period`, `incremental`, `exclusion`, `default` - the same fields and values as "Create backup configuration". - `schedule` is replaced whole: when it is sent it carries every field it needs (`frequency`, `start_hour`, `timezone` and the day its frequency asks for); when it is left out the stored one stays. - The frequency, the retention and `incremental` are validated together, with the stored value of the ones you leave out. A `retention_period` the stored frequency does not allow answers 422, and so does a weekly `schedule` sent to a configuration that still has `incremental` on: send `incremental: false` with it. - A new schedule reaches every website that uses the configuration and reschedules their next copy. A new `retention_period` moves the expiry of the copies 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 and sending `batch` answers 422. Requires a full-access token (read-only tokens answer 403). A configuration of another organization answers 404.

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

Edits one backup global configuration. Send only what changes; answers 200 with the configuration document.

Body (JSON), every field optional: name, region, schedule, retention_period, incremental, exclusion, default - the same fields and values as “Create backup configuration”.

schedule is replaced whole: when it is sent it carries every field it needs (frequency, start_hour, timezone and the day its frequency asks for); when it is left out the stored one stays.
The frequency, the retention and incremental are validated together, with the stored value of the ones you leave out. A retention_period the stored frequency does not allow answers 422, and so does a weekly schedule sent to a configuration that still has incremental on: send incremental: false with it.
A new schedule reaches every website that uses the configuration and reschedules their next copy. A new retention_period moves the expiry of the copies 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 and sending batch answers 422.

Requires a full-access token (read-only tokens answer 403). A configuration of another organization answers 404.