List backup configurations | Modular DS

{
  "data": [
    {
      "attributes": {
        "created_at": "2026-09-01T09:00:00.000000Z",
        "exclusion": {
          "extensions": [
            "zip",
            "log"
          ],
          "max_file_size": 209715200
        },
        "incremental": false,
        "is_default": true,
        "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-01T09:00:00.000000Z"
      },
      "id": "12",
      "links": {
        "self": "{{base_url}}/api/public/v1/preset-backups/12"
      },
      "type": "preset-backups"
    },
    {
      "attributes": {
        "created_at": "2026-08-01T09:00:00.000000Z",
        "exclusion": {
          "extensions": [],
          "max_file_size": null
        },
        "incremental": false,
        "is_default": false,
        "name": "Weekly full",
        "region": "eu-west-1",
        "retention_period": 14,
        "schedule": {
          "day_month": null,
          "day_week": "monday",
          "frequency": "weekly",
          "start_hour": "02:00",
          "timezone": "Europe/Madrid"
        },
        "sites_count": 7,
        "status": "enabled",
        "updated_at": "2026-09-10T09:00:00.000000Z"
      },
      "id": "13",
      "links": {
        "self": "{{base_url}}/api/public/v1/preset-backups/13"
      },
      "type": "preset-backups"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/preset-backups?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/preset-backups?page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "active": false,
        "label": "&laquo; Previous",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "{{base_url}}/api/public/v1/preset-backups?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/preset-backups",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

List the organization’s backup global configurations (presets): the named schedules applied to websites, with how many websites use each and which one is the default for new websites. The id is what the preset_backup field of “Create connection plugin” (POST /api/public/v1/connection-plugins) takes, and what the requests under “Backup Configurations” address: read one, create, edit or delete it, and assign websites to it there.

Every row carries the same attributes as “Show backup configuration”, under the keys the writes accept: name (may be null), status (enabled, disabled), is_default, region, schedule (frequency, start_hour, timezone, day_week, day_month), retention_period (days each copy is kept), incremental, exclusion (extensions, max_file_size in bytes), sites_count (opt in with fields[preset-backups]=sites_count), created_at, updated_at.

List the organization's backup global configurations (presets): the named schedules applied to websites, with how many websites use each and which one is the default for new websites. The id is what the `preset_backup` field of "Create connection plugin" (`POST /api/public/v1/connection-plugins`) takes, and what the requests under "Backup Configurations" address: read one, create, edit or delete it, and assign websites to it there. Every row carries the same attributes as "Show backup configuration", under the keys the writes accept: `name` (may be null), `status` (enabled, disabled), `is_default`, `region`, `schedule` (`frequency`, `start_hour`, `timezone`, `day_week`, `day_month`), `retention_period` (days each copy is kept), `incremental`, `exclusion` (`extensions`, `max_file_size` in bytes), `sites_count` (opt in with `fields[preset-backups]=sites_count`), `created_at`, `updated_at`.

Authentication

AuthorizationBearer

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

Query parameters

filter[id]stringOptional

Exact configuration ids

filter[s]stringOptional

Free-text search over the configuration name

filter[is_default]stringOptional

1 = only the default configuration for new websites; 0 = the others

filter[status]stringOptional

Comma list: enabled, disabled

sortstringOptional

name (default), -name, created_at, sites_count (prefix - for descending)

page[number]stringOptional

Page number

page[size]stringOptional

Items per page, max 50

fields[preset-backups]stringOptional

Opt into the computed website count

Response

200 - Backup configurations

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional