> 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 backups GET https://api.modulards.com/api/public/v1/site-backups Lists the backups of every website your token can reach, newest first. Use `filter[site][]` for the backups of one or several websites, or `filter[id][]` with the ids a create or retry returned to follow that batch. Read `phase` to know where a backup stands: `in_progress` (still running), `done` (a usable copy) or `failed`. A failed or stalled backup is retried automatically, up to 3 times (4 attempts in all, counted in `attempts`), within 24 hours of its creation: a rolling 24 hours from its creation time, not the rest of the calendar day. Once a backup has not changed for two hours, the server queues it again; after that it stays failed and `attempts` reads 4. `excluded` is the phase of a part that had nothing to copy, so it never matches a whole backup (see `include=items` on "Retrieve a backup"). `status` is the raw processing step behind the phase. `is_favorite` marks a master backup, which is kept out of the retention policy. Your role must be allowed to read backups; without it the request answers 404. Reference: https://api.docs.modulards.com/modular-ds-public-api/backups/website-backups/list-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. Repeat the parameter for several: any of them matches. - `filter[id][]` (string, optional) — Exact backup ids, for example the ones a create or retry returned. Repeat the parameter for several. - `filter[phase][]` (string, optional) — `in_progress`, `done`, `failed` or `excluded`. Repeat the parameter for several. Only `done` is a usable copy. - `filter[status][]` (string, optional) — Raw processing steps, for example `done`, `pending`, `in_progress`, `uploading`, `failed`, `failed_in_creation`, `failed_export_database`, `failed_export_files`, `storage_exceeded`. Repeat the parameter for several. Use `filter[phase][]` unless you need the exact step. - `filter[backup_type][]` (string, optional) — `full` or `incremental`. Repeat the parameter for several. Named `backup_type` because `type` is reserved in JSON:API. - `filter[method][]` (string, optional) — How the backup started: `manual`, `automatic` for a scheduled one, or `force_first` for the first automatic backup of a website. Repeat the parameter for several: any of them matches. - `filter[is_favorite]` (string, optional) — `1` returns only master backups; `0` returns only the ones that follow the retention policy. - `include` (string, optional) — Relations to add to the answer, comma separated: `site` (the website each backup belongs to) and `items` (the parts of each backup). - `sort` (string, optional) — `created_at` or `size` (in bytes); prefix with `-` for descending. Default: `-created_at` (newest first). - `page[number]` (string, optional) — Page number, starting at 1. Default 1. - `page[size]` (string, optional) — Items per page, 1 to 50. Default 15. - `fields[site-backups]` (string, optional) — Sparse fieldset: only the attributes named here are answered. `content`, `restoration_allowed` and `has_restoration_in_progress` are computed only when named here. ## Response ### 200 200 - Site backups - `data` (list of ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaDataItems, optional) - `jsonapi` (ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaJsonapi, optional) - `links` (ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaLinks, optional) - `meta` (ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaMeta, optional) ## Types ### ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaDataItems - `attributes` (ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaDataItemsAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaDataItemsLinks, optional) - `type` (string, optional) ### ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaJsonapi - `version` (string, optional) ### ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaLinks - `first` (string, optional) - `last` (string, optional) - `next` (any, optional, nullable) - `prev` (any, optional, nullable) ### ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaMeta - `current_page` (double, optional) - `from` (double, optional) - `last_page` (double, optional) - `links` (list of ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaMetaLinksItems, optional) - `path` (string, optional) - `per_page` (double, optional) - `to` (double, optional) - `total` (double, optional) ### ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaDataItemsAttributes - `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) ### ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaDataItemsLinks - `self` (string, optional) ### ApiPublicV1SiteBackupsGetResponsesContentApplicationJsonSchemaMetaLinksItems - `active` (boolean, optional) - `label` (string, optional) - `url` (string, optional, nullable) ## 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() ```