Retrieve a backup global configuration

GET

https://api.modulards.com/api/public/v1/preset-backups/:preset_backup

GET

/api/public/v1/preset-backups/:preset_backup

curl https://api.modulards.com/api/public/v1/preset-backups/preset_backup \
     -H "Authorization: Bearer <token>"

200200 - Backup configuration

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

Returns one backup global configuration: its schedule, retention period, exclusions, storage region and whether new websites receive it by default. Ids come from “List backup global configurations”.

Unlike the other global configurations, sites_count, the number of websites that use it, is computed only when fields[preset-backups] names it; a fieldset that names only sites_count answers only that attribute.

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

Sparse fieldset: only the attributes named here are answered. sites_count, the number of websites that use the configuration, is computed only when named here; a fieldset that names only sites_count answers only that attribute.

Response

200 - Backup configuration

dataobjectOptional

jsonapiobjectOptional