Update a backup's comment

PATCH

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

PATCH

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

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

200Update a backup's comment

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

Writes the comment of one backup, replacing whatever it held: use it to record why the backup was taken. Send null or omit the field to clear it. The stored value is purified HTML: plain text comes back wrapped in a paragraph.

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

Body

comment (string or null, optional): at most 2500 bytes once HTML tags are stripped (a character outside plain ASCII counts as more than one byte).

Errors

422: the comment is not a string or is too long.

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.

commentstringOptional

Response

200 - Site backup comment updated

dataobjectOptional

jsonapiobjectOptional