> 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.

# Summarize backups

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

Returns one row per website: its newest backup, when it last had a usable backup, how much storage its backups use and how many backups it has. Use it to answer "which websites have no recent backup?" in one call. The backups behind a row are listed by "List backups" with `filter[site][]`.

The rows are websites, so the website filters of "List websites" apply and the rows come in the websites' default order. Only `filter` and `page` are accepted: `sort`, `include` and `fields` answer 422.

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/summarize-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[id][]` (string, optional) — Exact website ids. Repeat the parameter for several: any of them matches.
- `filter[team][]` (string, optional) — Team ids. Repeat the parameter for several: any of them matches.
- `filter[tags][]` (string, optional) — Tag ids. Repeat the parameter for several: any of them matches.
- `filter[connected]` (string, optional) — `1` returns only connected websites; `0` only disconnected ones.
- `filter[s]` (string, optional) — Free-text search over the website name or address.
- `filter[core_version][]` (string, optional) — Exact WordPress versions, for example `6.8.1`. Repeat the parameter for several: any of them matches.
- `filter[engine_version][]` (string, optional) — Exact PHP versions, for example `8.2.27`. Repeat the parameter for several: any of them matches.
- `filter[alerts][]` (string, optional) — Notification configuration ids: only the websites that use any of them.
- `page[number]` (string, optional) — Page number, starting at 1. Default 1.
- `page[size]` (string, optional) — Items per page, 1 to 50. Default 15.
- `filter[patchstack]` (string, optional) — `1` returns only the websites with Patch & Protect protection; `0` only the ones without.

## Response

### 200

200 - Site backups summary

- `data` (list of ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaDataItems, optional)
- `jsonapi` (ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaJsonapi, optional)
- `links` (ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaLinks, optional)
- `meta` (ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaMeta, optional)

## Types

### ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaDataItems

- `attributes` (ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaDataItemsAttributes, optional)
- `id` (string, optional) — Website id.
- `type` (string, optional)

### ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaJsonapi

- `version` (string, optional)

### ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaLinks

- `first` (string, optional)
- `last` (string, optional)
- `next` (any, optional, nullable)
- `prev` (any, optional, nullable)

### ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaMeta

- `current_page` (double, optional)
- `from` (double, optional)
- `last_page` (double, optional)
- `links` (list of ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaMetaLinksItems, optional)
- `path` (string, optional)
- `per_page` (double, optional)
- `to` (double, optional)
- `total` (double, optional)

### ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaDataItemsAttributes

- `last_backup` (ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaDataItemsAttributesLastBackup, optional, nullable) — The newest backup whatever its phase; null when the website has none.
- `last_done_at` (string, optional, nullable) — When the last usable backup was taken; null when there is none.
- `site` (ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaDataItemsAttributesSite, optional)
- `storage_used` (integer, optional) — Bytes used by the website's backups.
- `total_count` (integer, optional) — Number of backups the website has.

### ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaMetaLinksItems

- `active` (boolean, optional)
- `label` (string, optional)
- `url` (string, optional, nullable)

### ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaDataItemsAttributesLastBackup

The newest backup whatever its phase; null when the website has none.

- `created_at` (string, optional) — When the backup was created (ISO 8601).
- `id` (integer, optional) — Backup id.
- `phase` (enum, optional) — in_progress, done, failed or excluded.
  - Allowed values: `in_progress`, `done`, `failed`, `excluded`
- `status` (string, optional) — Raw processing step behind the phase.

### ApiPublicV1SiteBackupsSummaryGetResponsesContentApplicationJsonSchemaDataItemsAttributesSite

- `id` (integer, optional) — Website id.
- `name` (string, optional) — Website name.

## Examples

**Response**

```json
{
  "data": [
    {
      "attributes": {
        "last_backup": {
          "created_at": "2026-09-18T03:00:00.000000Z",
          "id": 9001,
          "phase": "done",
          "status": "done"
        },
        "last_done_at": "2026-09-18T03:05:00.000000Z",
        "site": {
          "id": 12,
          "name": "Shop"
        },
        "storage_used": 314572800,
        "total_count": 6
      },
      "id": "12",
      "type": "site-backup-summaries"
    },
    {
      "attributes": {
        "last_backup": null,
        "last_done_at": null,
        "site": {
          "id": 13,
          "name": "Blog"
        },
        "storage_used": 0,
        "total_count": 0
      },
      "id": "13",
      "type": "site-backup-summaries"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/site-backups/summary?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/site-backups/summary?page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "active": false,
        "label": "&laquo; Previous",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "{{base_url}}/api/public/v1/site-backups/summary?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/site-backups/summary",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}
```

**SDK Code**

```python 200 - Site backups summary
import requests

url = "https://api.modulards.com/api/public/v1/site-backups/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript 200 - Site backups summary
const url = 'https://api.modulards.com/api/public/v1/site-backups/summary';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 200 - Site backups summary
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.modulards.com/api/public/v1/site-backups/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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 summary
require 'uri'
require 'net/http'

url = URI("https://api.modulards.com/api/public/v1/site-backups/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java 200 - Site backups summary
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.modulards.com/api/public/v1/site-backups/summary")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 - Site backups summary
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.modulards.com/api/public/v1/site-backups/summary', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp 200 - Site backups summary
using RestSharp;

var client = new RestClient("https://api.modulards.com/api/public/v1/site-backups/summary");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 - Site backups summary
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/site-backups/summary")! 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()
```