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

# Create backup configuration

POST https://api.modulards.com/api/public/v1/preset-backups
Content-Type: application/json

Creates a backup global configuration: a named schedule you then assign to websites. Answers **201** with the configuration document and a `Location` header. Creating it backs nothing up yet - assign websites with "Assign websites to a backup configuration".

**Body** (JSON):
- `name` (string, required, max 255).
- `region` (string, required) - where the copies are stored: `eu-west-1`, `us-east-1`, `ap-southeast-1`.
- `schedule` (object, required): `frequency` (`daily`, `weekly`, `monthly` - your plan decides which are available), `start_hour` (`HH:MM`, 24 hours), `timezone` (IANA name, e.g. `Europe/Madrid`), `day_week` (`monday` ... `sunday`; required for a weekly schedule and for a daily one with incremental copies, refused otherwise), `day_month` (1-31; required for a monthly schedule, refused otherwise).
- `retention_period` (integer, required) - days each copy is kept: 3, 7, 14, 30, 45, 60 or 90. The frequency and your plan decide which values are accepted.
- `incremental` (boolean, optional) - daily schedules only; the weekly full copy runs on `day_week`.
- `exclusion` (object, optional): `extensions` (array of file extensions left out of every copy), `max_file_size` (bytes, 104857600 to 1073741824, or null for no limit).
- `default` (boolean, optional) - `true` makes it the configuration new websites receive.

The technical batch sizes of a copy are not part of this API: a new configuration takes safe values and sending `batch` answers 422.

Requires a full-access token (read-only tokens answer 403). Validation failures answer 422 with a JSON:API `errors` document.

Reference: https://api.docs.modulards.com/modular-ds-public-api/backup-configurations/create-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

### Body (application/json)

This endpoint expects an object.

- `default` (boolean, optional)
- `exclusion` (object, optional)
  - `extensions` (list of string, optional)
  - `max_file_size` (double, optional)
- `name` (string, optional)
- `region` (string, optional)
- `retention_period` (double, optional)
- `schedule` (object, optional)
  - `frequency` (string, optional)
  - `start_hour` (string, optional)
  - `timezone` (string, optional)

## Response

### 201

201 - Backup configuration created

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

### 201 - Backup configuration created

**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": 30,
      "schedule": {
        "day_month": null,
        "day_week": null,
        "frequency": "daily",
        "start_hour": "03:00",
        "timezone": "Europe/Madrid"
      },
      "status": "enabled",
      "updated_at": "2026-09-17T09:12:44.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 201 - Backup configuration created
import requests

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

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

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

print(response.json())
```

```javascript 201 - Backup configuration created
const url = 'https://api.modulards.com/api/public/v1/preset-backups';
const options = {method: 'POST', 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 201 - Backup configuration created
package main

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

func main() {

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

	req, _ := http.NewRequest("POST", 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 201 - Backup configuration created
require 'uri'
require 'net/http'

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

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

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

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

```java 201 - Backup configuration created
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

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

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

$client = new \GuzzleHttp\Client();

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

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

```csharp 201 - Backup configuration created
using RestSharp;

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

```swift 201 - Backup configuration created
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/preset-backups")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```

### Create backup configuration

**Request**

```json
{
  "default": false,
  "exclusion": {
    "extensions": [
      "zip",
      "log"
    ],
    "max_file_size": 209715200
  },
  "name": "Nightly",
  "region": "eu-west-1",
  "retention_period": 30,
  "schedule": {
    "frequency": "daily",
    "start_hour": "03:00",
    "timezone": "Europe/Madrid"
  }
}
```

**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": 30,
      "schedule": {
        "day_month": null,
        "day_week": null,
        "frequency": "daily",
        "start_hour": "03:00",
        "timezone": "Europe/Madrid"
      },
      "status": "enabled",
      "updated_at": "2026-09-17T09:12:44.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 Create backup configuration
import requests

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

payload = {
    "default": False,
    "exclusion": {
        "extensions": ["zip", "log"],
        "max_file_size": 209715200
    },
    "name": "Nightly",
    "region": "eu-west-1",
    "retention_period": 30,
    "schedule": {
        "frequency": "daily",
        "start_hour": "03:00",
        "timezone": "Europe/Madrid"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Create backup configuration
const url = 'https://api.modulards.com/api/public/v1/preset-backups';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"default":false,"exclusion":{"extensions":["zip","log"],"max_file_size":209715200},"name":"Nightly","region":"eu-west-1","retention_period":30,"schedule":{"frequency":"daily","start_hour":"03:00","timezone":"Europe/Madrid"}}'
};

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

```go Create backup configuration
package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"default\": false,\n  \"exclusion\": {\n    \"extensions\": [\n      \"zip\",\n      \"log\"\n    ],\n    \"max_file_size\": 209715200\n  },\n  \"name\": \"Nightly\",\n  \"region\": \"eu-west-1\",\n  \"retention_period\": 30,\n  \"schedule\": {\n    \"frequency\": \"daily\",\n    \"start_hour\": \"03:00\",\n    \"timezone\": \"Europe/Madrid\"\n  }\n}")

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

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"default\": false,\n  \"exclusion\": {\n    \"extensions\": [\n      \"zip\",\n      \"log\"\n    ],\n    \"max_file_size\": 209715200\n  },\n  \"name\": \"Nightly\",\n  \"region\": \"eu-west-1\",\n  \"retention_period\": 30,\n  \"schedule\": {\n    \"frequency\": \"daily\",\n    \"start_hour\": \"03:00\",\n    \"timezone\": \"Europe/Madrid\"\n  }\n}"

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

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

HttpResponse<String> response = Unirest.post("https://api.modulards.com/api/public/v1/preset-backups")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"default\": false,\n  \"exclusion\": {\n    \"extensions\": [\n      \"zip\",\n      \"log\"\n    ],\n    \"max_file_size\": 209715200\n  },\n  \"name\": \"Nightly\",\n  \"region\": \"eu-west-1\",\n  \"retention_period\": 30,\n  \"schedule\": {\n    \"frequency\": \"daily\",\n    \"start_hour\": \"03:00\",\n    \"timezone\": \"Europe/Madrid\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.modulards.com/api/public/v1/preset-backups', [
  'body' => '{
  "default": false,
  "exclusion": {
    "extensions": [
      "zip",
      "log"
    ],
    "max_file_size": 209715200
  },
  "name": "Nightly",
  "region": "eu-west-1",
  "retention_period": 30,
  "schedule": {
    "frequency": "daily",
    "start_hour": "03:00",
    "timezone": "Europe/Madrid"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Create backup configuration
using RestSharp;

var client = new RestClient("https://api.modulards.com/api/public/v1/preset-backups");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"default\": false,\n  \"exclusion\": {\n    \"extensions\": [\n      \"zip\",\n      \"log\"\n    ],\n    \"max_file_size\": 209715200\n  },\n  \"name\": \"Nightly\",\n  \"region\": \"eu-west-1\",\n  \"retention_period\": 30,\n  \"schedule\": {\n    \"frequency\": \"daily\",\n    \"start_hour\": \"03:00\",\n    \"timezone\": \"Europe/Madrid\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Create backup configuration
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "default": false,
  "exclusion": [
    "extensions": ["zip", "log"],
    "max_file_size": 209715200
  ],
  "name": "Nightly",
  "region": "eu-west-1",
  "retention_period": 30,
  "schedule": [
    "frequency": "daily",
    "start_hour": "03:00",
    "timezone": "Europe/Madrid"
  ]
] 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")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```