Update site backup comment | Modular DS

Writes the comment of one backup, replacing whatever it held; send null or omit the field to clear it. The stored value is purified HTML (plain text comes back wrapped in a paragraph).

Body parameters:

comment (string, nullable): max 2500 characters after HTML tags are stripped.

Answers 200 with the site-backups document. Path variable siteBackup is the exact backup id.

422: the comment is not a string or exceeds the length.
403: a read-only token.
404: a backup of another organization, or a member without the update permission.

The MCP twin is the site-backups-update tool.

Writes the comment of one backup, replacing whatever it held; send `null` or omit the field to clear it. The stored value is purified HTML (plain text comes back wrapped in a paragraph). Body parameters: - `comment` (string, nullable): max 2500 characters after HTML tags are stripped. Answers **200** with the `site-backups` document. Path variable `siteBackup` is the exact backup id. - **422**: the comment is not a string or exceeds the length. - **403**: a read-only token. - **404**: a backup of another organization, or a member without the update permission. The MCP twin is the `site-backups-update` tool.

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

Authentication

Path parameters

Request

Response