Retrieve a website's backup settings

GET

https://api.modulards.com/api/public/v1/backup-services/:site_preset_backup

GET

/api/public/v1/backup-services/:site_preset_backup

curl https://api.modulards.com/api/public/v1/backup-services/site_preset_backup \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "attributes": {
      "content": {
        "excluded": {
          "content": null,
          "core": null,
          "database": [],
          "files": [],
          "fonts": null,
          "mu_plugins": null,
          "plugins": null,
          "themes": null,
          "uploads": null
        },
        "included": [
          "core",
          "database"
        ]
      },
      "created_at": "2026-09-01T08:30:00.000000Z",
      "filesystem": "default",
      "last_request": "2026-09-17T01:00:00.000000Z",
      "next_request": "2026-09-18T01:00:00.000000Z",
      "schedule": {
        "day_month": null,
        "day_week": null,
        "frequency": "daily",
        "start_hour": "03:00",
        "timezone": "Europe/Madrid"
      },
      "status": "enabled",
      "updated_at": "2026-09-17T01:00:05.000000Z"
    },
    "id": "845",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/backup-services/845"
    },
    "type": "site-preset-backups"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Returns how one website is backed up: whether its automatic backups are on, the schedule it inherits from its global configuration, which areas are copied (filesystem and content.included) and the exclusions configured in the dashboard. The values read back under the same keys “Update a website’s backup settings” accepts.

The id is the website’s backup settings id: read it from the site_preset_backup include of “Retrieve a website” (?include=site_preset_backup, which also carries the global configuration the website uses) or from meta.updated of “Assign websites to a backup global configuration”.

A website that was never assigned a global configuration has no backup settings.

Authentication

AuthorizationBearer

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

Path parameters

site_preset_backupstringRequired

Query parameters

includestringOptional

Relations to add to the answer: preset (the global configuration the website uses) and last_backup (its last backup), comma separated. None by default. Any other name, including the camelCase lastBackup, answers 400.

Response

200 - Backup service / 200 - Backup service with preset and last backup (include=preset,last_backup)

dataobjectOptional

includedlist of objectsOptional

jsonapiobjectOptional

Errors

400

Bad Request Error