> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api.docs.modulards.com/modular-ds-public-api/backups/backup-global-configurations/retrieve-a-backup-global-configuration/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server.

# Retrieve a backup global configuration

GET https://api.modulards.com/api/public/v1/preset-backups/{preset_backup}

Returns one backup global configuration: its schedule, retention period, exclusions, storage region and whether new websites receive it by default. Ids come from "List backup global configurations".

Unlike the other global configurations, `sites_count`, the number of websites that use it, is computed only when `fields[preset-backups]` names it; a fieldset that names only `sites_count` answers only that attribute.

Reference: https://api.docs.modulards.com/modular-ds-public-api/backups/backup-global-configurations/retrieve-a-backup-global-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)

### Query parameters

- `fields[preset-backups]` (string, optional) — Sparse fieldset: only the attributes named here are answered. `sites_count`, the number of websites that use the configuration, is computed only when named here; a fieldset that names only `sites_count` answers only that attribute.

## Response

### 200

200 - Backup configuration

- `data` (ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaData, optional)
- `jsonapi` (ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaJsonapi, optional)

## Types

### ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaData

- `attributes` (ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaDataAttributes, optional)
- `id` (string, optional)
- `links` (ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaDataLinks, optional)
- `type` (string, optional)

### ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaJsonapi

- `version` (string, optional)

### ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaDataAttributes

- `created_at` (string, optional)
- `exclusion` (ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaDataAttributesExclusion, optional)
- `incremental` (boolean, optional)
- `is_default` (boolean, optional)
- `name` (string, optional)
- `region` (string, optional)
- `retention_period` (double, optional)
- `schedule` (ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaDataAttributesSchedule, optional)
- `status` (string, optional)
- `updated_at` (string, optional)

### ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaDataLinks

- `self` (string, optional)

### ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaDataAttributesExclusion

- `extensions` (list of string, optional)
- `max_file_size` (double, optional)

### ApiPublicV1PresetBackupsPresetBackupGetResponsesContentApplicationJsonSchemaDataAttributesSchedule

- `day_month` (any, optional, nullable)
- `day_week` (any, optional, nullable)
- `frequency` (string, optional)
- `start_hour` (string, optional)
- `timezone` (string, optional)

## Examples

**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 200 - Backup configuration
import requests

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

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

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

print(response.json())
```

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

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

func main() {

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

	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 - 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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

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

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

$client = new \GuzzleHttp\Client();

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

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

```csharp 200 - Backup configuration
using RestSharp;

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

```swift 200 - Backup configuration
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 = "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()
```