Set or unset a master backup

PATCH

https://api.modulards.com/api/public/v1/site-backups/:siteBackup/favorite

PATCH

/api/public/v1/site-backups/:siteBackup/favorite

curl -X PATCH https://api.modulards.com/api/public/v1/site-backups/siteBackup/favorite \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "favorite": true
}'

200Set or unset a master backup

{
  "data": {
    "attributes": {
      "attempts": 0,
      "backup_type": "full",
      "comment": null,
      "created_at": "2026-09-18T03:00:00.000000Z",
      "is_favorite": true,
      "method": "manual",
      "phase": "done",
      "restored_at": null,
      "site_id": 12,
      "size": 104857600,
      "status": "done",
      "updated_at": "2026-09-18T10:20:00.000000Z"
    },
    "id": "9001",
    "links": {
      "self": "{{base_url}}/api/public/v1/site-backups/9001"
    },
    "type": "site-backups"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Marks one backup as a master backup, or takes the mark off. A master backup is kept out of the retention policy, so it never expires while marked. You set the state explicitly, so repeating the call leaves the same state.

Your role must be allowed to mark backups; without it the request answers 404.

Body

favorite (boolean, required): true marks the backup as a master backup, false takes the mark off.

Errors

400: your plan’s cap of master backups for that website is reached. The error names it and nothing changes.
422: favorite is missing or not a boolean.

Authentication

AuthorizationBearer

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

Path parameters

siteBackupstringRequired

Request

This endpoint expects an object.

favoritebooleanOptional

Response

200 - Site backup favorite updated

dataobjectOptional

jsonapiobjectOptional