> 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 backup configuration

PATCH https://api.modulards.com/api/public/v1/preset-backups/{preset_backup}
Content-Type: application/json

Edits one backup global configuration. Send only what changes; answers **200** with the configuration document.

**Body** (JSON), every field optional: `name`, `region`, `schedule`, `retention_period`, `incremental`, `exclusion`, `default` - the same fields and values as "Create backup configuration".

- `schedule` is replaced whole: when it is sent it carries every field it needs (`frequency`, `start_hour`, `timezone` and the day its frequency asks for); when it is left out the stored one stays.
- The frequency, the retention and `incremental` are validated together, with the stored value of the ones you leave out. A `retention_period` the stored frequency does not allow answers 422, and so does a weekly `schedule` sent to a configuration that still has `incremental` on: send `incremental: false` with it.
- A new schedule reaches every website that uses the configuration and reschedules their next copy. A new `retention_period` moves the expiry of the copies those websites already hold, so a shorter retention brings deletions forward.
- `default: true` makes it the configuration new websites receive and takes the mark off the previous one; `default: false` clears it.

The technical batch sizes are not part of this API: the configuration keeps the ones it has and sending `batch` answers 422.

Requires a full-access token (read-only tokens answer 403). A configuration of another organization answers 404.

Reference: https://api.docs.modulards.com/modular-ds-public-api/backup-configurations/update-backup-configuration

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

- `preset_backup` (string, required)

### Body (application/json)

This endpoint expects an object.

- `retention_period` (double, optional)

## Response

### 200

200 - Backup configuration updated

- `data` (object, optional)
  - `attributes` (object, optional)
    - `created_at` (string, optional)
    - `exclusion` (object, optional)
      - `extensions` (list of string, optional)
      - `max_file_size` (double, optional)
    - `incremental` (boolean, optional)
    - `is_default` (boolean, optional)
    - `name` (string, optional)
    - `region` (string, optional)
    - `retention_period` (double, optional)
    - `schedule` (object, optional)
      - `day_month` (any, optional, nullable)
      - `day_week` (any, optional, nullable)
      - `frequency` (string, optional)
      - `start_hour` (string, optional)
      - `timezone` (string, 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 - Backup configuration updated

**Request**

```json
undefined
```

**Response**

```json
{
  "data": {
    "attributes": {
      "created_at": "2026-09-17T09:12:44.000000Z",
      "exclusion": {
        "extensions": [
          "zip",
          "log"
        ],
        "max_file_size": 209715200
      },
      "incremental": false,
      "is_default": false,
      "name": "Nightly",
      "region": "eu-west-1",
      "retention_period": 14,
      "schedule": {
        "day_month": null,
        "day_week": null,
        "frequency": "daily",
        "start_hour": "03:00",
        "timezone": "Europe/Madrid"
      },
      "status": "enabled",
      "updated_at": "2026-09-17T10:03:10.000000Z"
    },
    "id": "12",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/preset-backups/12"
    },
    "type": "preset-backups"
  },
  "jsonapi": {
    "version": "1.1"
  }
}
```

**SDK Code**

```python 200 - Backup configuration updated
import requests

url = "https://api.modulards.com/api/public/v1/preset-backups/preset_backup"

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

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

print(response.json())
```

```javascript 200 - Backup configuration updated
const url = 'https://api.modulards.com/api/public/v1/preset-backups/preset_backup';
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 - Backup configuration updated
package main

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

func main() {

	url := "https://api.modulards.com/api/public/v1/preset-backups/preset_backup"

	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 - Backup configuration updated
require 'uri'
require 'net/http'

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

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 - Backup configuration 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/preset-backups/preset_backup")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 - Backup configuration updated
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp 200 - Backup configuration updated
using RestSharp;

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

```swift 200 - Backup configuration updated
import Foundation

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

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

**Request**

```json
{
  "retention_period": 14
}
```

**Response**

```json
{
  "data": {
    "attributes": {
      "created_at": "2026-09-17T09:12:44.000000Z",
      "exclusion": {
        "extensions": [
          "zip",
          "log"
        ],
        "max_file_size": 209715200
      },
      "incremental": false,
      "is_default": false,
      "name": "Nightly",
      "region": "eu-west-1",
      "retention_period": 14,
      "schedule": {
        "day_month": null,
        "day_week": null,
        "frequency": "daily",
        "start_hour": "03:00",
        "timezone": "Europe/Madrid"
      },
      "status": "enabled",
      "updated_at": "2026-09-17T10:03:10.000000Z"
    },
    "id": "12",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/preset-backups/12"
    },
    "type": "preset-backups"
  },
  "jsonapi": {
    "version": "1.1"
  }
}
```

**SDK Code**

```python Update backup configuration
import requests

url = "https://api.modulards.com/api/public/v1/preset-backups/preset_backup"

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

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

print(response.json())
```

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

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

```go Update backup configuration
package main

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

func main() {

	url := "https://api.modulards.com/api/public/v1/preset-backups/preset_backup"

	payload := strings.NewReader("{\n  \"retention_period\": 14\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 backup configuration
require 'uri'
require 'net/http'

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

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  \"retention_period\": 14\n}"

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

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

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

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

$client = new \GuzzleHttp\Client();

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

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

```csharp Update backup configuration
using RestSharp;

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

```swift Update backup configuration
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["retention_period": 14] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

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