> 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 site backup favorite

PATCH https://api.modulards.com/api/public/v1/site-backups/{siteBackup}/favorite
Content-Type: application/json

Marks one backup as a master backup, or takes the mark off. A master backup is kept out of the retention policy, so it never expires while marked. The state is explicit, never a flip: repeating the call leaves the same state.

Body parameters:
- `favorite` (boolean, required): `true` marks the copy as a master backup, `false` takes the mark off.

Answers **200** with the `site-backups` document (`is_favorite` reflects the new state). Path variable `siteBackup` is the exact backup id.

- **400**: the plan's cap of master backups for that website is reached (the error names it); nothing changes.
- **422**: `favorite` missing or not a boolean.
- **403**: a read-only token.
- **404**: a backup of another organization, or a member without the permission.

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

Reference: https://api.docs.modulards.com/modular-ds-public-api/backups/update-site-backup-favorite

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

- `favorite` (boolean, optional)

## Response

### 200

200 - Site backup favorite updated

- `data` (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)

## Examples

### 200 - Site backup favorite updated

**Request**

```json
undefined
```

**Response**

```json
{
  "data": {
    "attributes": {
      "attempts": 0,
      "backup_type": "full",
      "comment": null,
      "created_at": "2026-09-18T03:00:00.000000Z",
      "is_favorite": true,
      "method": "manual",
      "phase": "done",
      "restored_at": null,
      "site_id": 12,
      "size": 104857600,
      "status": "done",
      "updated_at": "2026-09-18T10:20: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 favorite updated
import requests

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

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

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

print(response.json())
```

```javascript 200 - Site backup favorite updated
const url = 'https://api.modulards.com/api/public/v1/site-backups/siteBackup/favorite';
const options = {method: 'PATCH', 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 backup favorite updated
package main

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

func main() {

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

	req, _ := http.NewRequest("PATCH", 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 backup favorite updated
require 'uri'
require 'net/http'

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

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

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

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

```java 200 - Site backup favorite updated
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

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

```php 200 - Site backup favorite updated
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp 200 - Site backup favorite updated
using RestSharp;

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

```swift 200 - Site backup favorite updated
import Foundation

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

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

**Request**

```json
{
  "favorite": true
}
```

**Response**

```json
{
  "data": {
    "attributes": {
      "attempts": 0,
      "backup_type": "full",
      "comment": null,
      "created_at": "2026-09-18T03:00:00.000000Z",
      "is_favorite": true,
      "method": "manual",
      "phase": "done",
      "restored_at": null,
      "site_id": 12,
      "size": 104857600,
      "status": "done",
      "updated_at": "2026-09-18T10:20: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 site backup favorite
import requests

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

payload = { "favorite": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript Update site backup favorite
const url = 'https://api.modulards.com/api/public/v1/site-backups/siteBackup/favorite';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"favorite":true}'
};

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

```go Update site backup favorite
package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"favorite\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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 site backup favorite
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"favorite\": true\n}"

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

```java Update site backup favorite
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.modulards.com/api/public/v1/site-backups/siteBackup/favorite")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"favorite\": true\n}")
  .asString();
```

```php Update site backup favorite
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.modulards.com/api/public/v1/site-backups/siteBackup/favorite', [
  'body' => '{
  "favorite": true
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Update site backup favorite
using RestSharp;

var client = new RestClient("https://api.modulards.com/api/public/v1/site-backups/siteBackup/favorite");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"favorite\": true\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Update site backup favorite
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["favorite": true] 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/favorite")! 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()
```