> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api.docs.modulards.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server. # Update a backup's comment PATCH https://api.modulards.com/api/public/v1/site-backups/{siteBackup} Content-Type: application/json 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. Reference: https://api.docs.modulards.com/modular-ds-public-api/backups/website-backups/update-a-backup-s-comment ## Authentication - `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints. ## Request ### Path parameters - `siteBackup` (string, required) ### Body (application/json) This endpoint expects an object. - `comment` (string, optional) ## Response ### 200 200 - Site backup comment updated - `data` (ApiPublicV1SiteBackupsSiteBackupPatchResponsesContentApplicationJsonSchemaData, optional) - `jsonapi` (ApiPublicV1SiteBackupsSiteBackupPatchResponsesContentApplicationJsonSchemaJsonapi, optional) ## Types ### ApiPublicV1SiteBackupsSiteBackupPatchResponsesContentApplicationJsonSchemaData - `attributes` (ApiPublicV1SiteBackupsSiteBackupPatchResponsesContentApplicationJsonSchemaDataAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1SiteBackupsSiteBackupPatchResponsesContentApplicationJsonSchemaDataLinks, optional) - `type` (string, optional) ### ApiPublicV1SiteBackupsSiteBackupPatchResponsesContentApplicationJsonSchemaJsonapi - `version` (string, optional) ### ApiPublicV1SiteBackupsSiteBackupPatchResponsesContentApplicationJsonSchemaDataAttributes - `attempts` (integer, optional) — Number of attempts made: 1 for the first run, plus one for each retry. A failed or stalled backup is retried automatically, up to 3 times (4 attempts in all), within 24 hours of its creation; after that it stays failed and reads 4. - `backup_type` (enum, optional) — full or incremental. - Allowed values: `full`, `incremental` - `comment` (string, optional, nullable) — Note written on the backup. - `created_at` (string, optional) - `is_favorite` (boolean, optional) — True for a master backup, kept out of the retention policy. - `method` (enum, optional) — How the backup started: manual, or automatic for scheduled ones. force_first is the first automatic backup of a website. - Allowed values: `manual`, `automatic`, `force_first` - `phase` (enum, optional) — State to read: in_progress while it runs, done for a usable backup, failed when it did not complete. - Allowed values: `in_progress`, `done`, `failed`, `excluded` - `restored_at` (datetime, optional, nullable) — When the backup was last restored; null if it never was. - `site_id` (integer, optional) — Id of the website the backup belongs to. - `size` (integer, optional) — Size of the backup, in bytes. - `status` (string, optional) — Raw processing step behind phase. - `updated_at` (string, optional) ### ApiPublicV1SiteBackupsSiteBackupPatchResponsesContentApplicationJsonSchemaDataLinks - `self` (string, optional) ## Examples ### 200 - Site backup comment updated **Response** ```json { "data": { "attributes": { "attempts": 0, "backup_type": "full", "comment": "

Before the redesign

", "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" } } ``` **SDK Code** ```python 200 - Site backup comment updated import requests url = "https://api.modulards.com/api/public/v1/site-backups/siteBackup" headers = {"Authorization": "Bearer "} response = requests.patch(url, headers=headers) print(response.json()) ``` ```javascript 200 - Site backup comment updated const url = 'https://api.modulards.com/api/public/v1/site-backups/siteBackup'; const options = {method: 'PATCH', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 200 - Site backup comment updated package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/site-backups/siteBackup" req, _ := http.NewRequest("PATCH", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby 200 - Site backup comment updated require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/site-backups/siteBackup") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 - Site backup comment updated import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.modulards.com/api/public/v1/site-backups/siteBackup") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - Site backup comment updated request('PATCH', 'https://api.modulards.com/api/public/v1/site-backups/siteBackup', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - Site backup comment updated using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/site-backups/siteBackup"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - Site backup comment updated import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/site-backups/siteBackup")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### Update a backup's comment **Request** ```json { "comment": "Before the redesign" } ``` **Response** ```json { "data": { "attributes": { "attempts": 0, "backup_type": "full", "comment": "

Before the redesign

", "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" } } ``` **SDK Code** ```python Update a backup's comment import requests url = "https://api.modulards.com/api/public/v1/site-backups/siteBackup" payload = { "comment": "Before the redesign" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Update a backup's comment const url = 'https://api.modulards.com/api/public/v1/site-backups/siteBackup'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"comment":"Before the redesign"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Update a backup's comment package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/site-backups/siteBackup" payload := strings.NewReader("{\n \"comment\": \"Before the redesign\"\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Update a backup's comment require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/site-backups/siteBackup") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"comment\": \"Before the redesign\"\n}" response = http.request(request) puts response.read_body ``` ```java Update a backup's comment import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.modulards.com/api/public/v1/site-backups/siteBackup") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"comment\": \"Before the redesign\"\n}") .asString(); ``` ```php Update a backup's comment request('PATCH', 'https://api.modulards.com/api/public/v1/site-backups/siteBackup', [ 'body' => '{ "comment": "Before the redesign" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Update a backup's comment using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/site-backups/siteBackup"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"comment\": \"Before the redesign\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Update a backup's comment import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["comment": "Before the redesign"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/site-backups/siteBackup")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```