> 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. # List site backups GET https://api.modulards.com/api/public/v1/site-backups Lists the backups of every website the token can reach, newest first, as a JSON:API collection of type `site-backups` with the usual `links` / `meta` pagination. Narrow with `filter[site][]` (exact website ids) or `filter[id][]` (the backup ids a create or retry answered) to follow a batch. Each entry carries `site_id`, `status`, `phase`, `attempts`, `backup_type` (`full` / `incremental`), `method` (`manual` / `automatic` / `force_first`), `size`, `is_favorite` (master backup, kept out of the retention policy), `restored_at`, `comment`, `created_at` and `updated_at`. `phase` is the state to read: `in_progress` (still running), `done` (a usable copy) or `failed` (the server retries a failed copy on its own up to four times during its first day; `attempts` counts them). `excluded` never matches a backup: it is the phase of a part that had nothing to copy - see `include=items` on the show endpoint. `status` is the raw pipeline step behind it. `include=site` adds the website; the parts of a copy (`include=items`) and the detail fields belong to the show endpoint. Websites of other organizations - and members without the backups read permission - answer 404; an unknown filter answers 400 and an invalid value 422. A read-only token is enough. The MCP twin of this endpoint is the `site-backups-index` tool. Reference: https://api.docs.modulards.com/modular-ds-public-api/backups/list-site-backups ## Authentication - `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints. ## Request ### Query parameters - `filter[site][]` (string, optional) — Exact website ids (repeatable) - `filter[id][]` (string, optional) — Exact backup ids, e.g. the ids a create or retry answered (repeatable) - `filter[phase][]` (string, optional) — in_progress | done | failed | excluded (repeatable). Only done is a usable copy - `filter[status][]` (string, optional) — Raw pipeline steps: done, pending, manifest_in_progress, manifest_upload_pending, manifest_uploading, manifest_done, in_progress, upload_pending, uploading, excluded, failed, failed_in_creation, failed_export_database, failed_export_files, failed_export_manifest, failed_in_processing, failed_uploaded, failed_partial, failed_file_not_found, storage_exceeded (repeatable) - `filter[backup_type][]` (string, optional) — full | incremental - the model's type column, aliased because type is reserved in JSON:API (repeatable) - `filter[method][]` (string, optional) — manual | automatic | force_first (repeatable) - `filter[is_favorite]` (string, optional) — 1|0 - only master backups, or only the rotating ones - `include` (string, optional) — site - the website each backup belongs to - `sort` (string, optional) — created_at, size; prefix with - to invert. Default: -created_at (newest first) - `page[number]` (string, optional) - `page[size]` (string, optional) — Max 50 ## Response ### 200 200 - Site backups - `data` (list of object, optional) - `attributes` (object, optional) - `attempts` (double, optional) - `backup_type` (string, optional) - `comment` (any, optional, nullable) - `created_at` (string, optional) - `is_favorite` (boolean, optional) - `method` (string, optional) - `phase` (string, optional) - `restored_at` (any, optional, nullable) - `site_id` (double, optional) - `size` (double, optional) - `status` (string, optional) - `updated_at` (string, optional) - `id` (string, optional) - `links` (object, optional) - `self` (string, optional) - `type` (string, optional) - `jsonapi` (object, optional) - `version` (string, optional) - `links` (object, optional) - `first` (string, optional) - `last` (string, optional) - `next` (any, optional, nullable) - `prev` (any, optional, nullable) - `meta` (object, optional) - `current_page` (double, optional) - `from` (double, optional) - `last_page` (double, optional) - `links` (list of object, optional) - `active` (boolean, optional) - `label` (string, optional) - `url` (string, optional, nullable) - `path` (string, optional) - `per_page` (double, optional) - `to` (double, optional) - `total` (double, optional) ## Examples **Response** ```json { "data": [ { "attributes": { "attempts": 0, "backup_type": "full", "comment": null, "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-18T03:05:00.000000Z" }, "id": "9001", "links": { "self": "{{base_url}}/api/public/v1/site-backups/9001" }, "type": "site-backups" }, { "attributes": { "attempts": 2, "backup_type": "full", "comment": null, "created_at": "2026-09-17T03:00:00.000000Z", "is_favorite": false, "method": "automatic", "phase": "failed", "restored_at": null, "site_id": 12, "size": 0, "status": "failed_export_database", "updated_at": "2026-09-17T03:10:00.000000Z" }, "id": "9000", "links": { "self": "{{base_url}}/api/public/v1/site-backups/9000" }, "type": "site-backups" } ], "jsonapi": { "version": "1.1" }, "links": { "first": "{{base_url}}/api/public/v1/site-backups?page%5Bnumber%5D=1", "last": "{{base_url}}/api/public/v1/site-backups?page%5Bnumber%5D=1", "next": null, "prev": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "active": false, "label": "« Previous", "url": null }, { "active": true, "label": "1", "url": "{{base_url}}/api/public/v1/site-backups?page%5Bnumber%5D=1" }, { "active": false, "label": "Next »", "url": null } ], "path": "{{base_url}}/api/public/v1/site-backups", "per_page": 15, "to": 2, "total": 2 } } ``` **SDK Code** ```python 200 - Site backups import requests url = "https://api.modulards.com/api/public/v1/site-backups" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - Site backups const url = 'https://api.modulards.com/api/public/v1/site-backups'; const options = {method: 'GET', 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 backups package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/site-backups" req, _ := http.NewRequest("GET", 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 backups require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/site-backups") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 - Site backups import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/site-backups") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - Site backups request('GET', 'https://api.modulards.com/api/public/v1/site-backups', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - Site backups using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/site-backups"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - Site backups import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/site-backups")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" 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() ```