Assign websites to a backup configuration

POST

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

POST

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

curl -X POST https://api.modulards.com/api/public/v1/preset-backups/preset_backup/sites/sync \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "sites": [
    101,
    102
  ]
}'

200Assign websites to a backup configuration

{
  "jsonapi": {
    "version": "1.1"
  },
  "meta": {
    "skipped": [
      {
        "message": "This website already uses this backup global configuration.",
        "reason_code": "ALREADY_APPLIED",
        "site_id": 102,
        "site_name": "Acme Blog",
        "site_preset_backup_id": 731
      }
    ],
    "status": "applied",
    "updated": [
      {
        "site_id": 101,
        "site_name": "Acme Shop",
        "site_preset_backup_id": 845
      }
    ]
  }
}

Assigns an explicit selection of websites to one backup global configuration. Answers 200 with meta.status (applied when at least one website changed, skipped when none did), meta.updated and meta.skipped; the change is immediate, there is nothing to poll.

Body (JSON):

sites (array of website ids, required, 1 to 200).

What happens to each website:

A website with no configuration gets this one. A website that used another one moves to this one, and the copies it already holds take this configuration’s retention.
Every assigned website is left with backups enabled, even if it was paused. To change the configuration of one website and keep it paused, use “Update backup service” instead.
Websites left out of the selection are never unassigned: a website leaves a configuration by moving to another one.
A website that already uses this configuration, or that the token cannot reach, is answered in meta.skipped with a reason_code (ALREADY_APPLIED, PERMISSION_DENIED) and a message instead of failing the call.

meta.updated entries carry site_id, site_name and site_preset_backup_id, the id “Show backup service” and “Update backup service” take.

Requires a full-access token (read-only tokens answer 403). An id that is not a website answers 422.

Assigns an explicit selection of websites to one backup global configuration. Answers **200** with `meta.status` (`applied` when at least one website changed, `skipped` when none did), `meta.updated` and `meta.skipped`; the change is immediate, there is nothing to poll. **Body** (JSON): - `sites` (array of website ids, required, 1 to 200). What happens to each website: - A website with no configuration gets this one. A website that used another one moves to this one, and the copies it already holds take this configuration's retention. - Every assigned website is left with backups **enabled**, even if it was paused. To change the configuration of one website and keep it paused, use "Update backup service" instead. - Websites left out of the selection are never unassigned: a website leaves a configuration by moving to another one. - A website that already uses this configuration, or that the token cannot reach, is answered in `meta.skipped` with a `reason_code` (`ALREADY_APPLIED`, `PERMISSION_DENIED`) and a message instead of failing the call. `meta.updated` entries carry `site_id`, `site_name` and `site_preset_backup_id`, the id "Show backup service" and "Update backup service" take. Requires a full-access token (read-only tokens answer 403). An id that is not a website answers 422.

Authentication

AuthorizationBearer

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

Path parameters

preset_backupstringRequired

Request

This endpoint expects an object.

siteslist of doublesOptional

Response

200 - Websites assigned, one skipped

jsonapiobjectOptional

metaobjectOptional