Show backup configuration | Modular DS

{
  "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"
  }
}

Read one backup global configuration. Ids come from “List backup presets”, which answers the same attributes for every configuration.

Response attributes, under the same keys the writes accept: name, status (enabled, disabled), is_default (true for the configuration new websites receive), region (where the copies are stored), schedule (frequency daily, weekly or monthly, start_hour HH:MM, timezone, day_week, day_month), retention_period (days each copy is kept), incremental, exclusion (extensions, max_file_size in bytes) and the timestamps. sites_count, how many websites use the configuration, is opt in with fields[preset-backups]=sites_count.

A configuration of another organization answers 404.

Read one backup global configuration. Ids come from "List backup presets", which answers the same attributes for every configuration. Response attributes, under the same keys the writes accept: `name`, `status` (enabled, disabled), `is_default` (true for the configuration new websites receive), `region` (where the copies are stored), `schedule` (`frequency` daily, weekly or monthly, `start_hour` HH:MM, `timezone`, `day_week`, `day_month`), `retention_period` (days each copy is kept), `incremental`, `exclusion` (`extensions`, `max_file_size` in bytes) and the timestamps. `sites_count`, how many websites use the configuration, is opt in with `fields[preset-backups]=sites_count`. 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

Query parameters

fields[preset-backups]stringOptional

Opt into the computed website count

Response

200 - Backup configuration

dataobjectOptional

jsonapiobjectOptional

Read one backup global configuration. Ids come from “List backup presets”, which answers the same attributes for every configuration.

A configuration of another organization answers 404.