---
title: List Site Backup Settings
description: "Returns the backup settings configured for the site. A site can have multiple entries (typically one local and one remote). The storage provider's credentials are never exposed — only its…"
url: "https://betterdocs.shahrear.msf.bd/index.php/docs/hell0-boys-docs/hell0-boys/sites/list-site-backup-settings/"
updated: "2026-08-20"
category: hell0 boys / Sites
---

# List Site Backup Settings

GET`/sites/{uuid}/backup-settings`

## Code Samples

```curl

                curl --request GET \
  --url 'https://app.xcloud.host/api/v1/sites/{uuid}/backup-settings' \
  --header 'Authorization: Bearer YOUR_TOKEN'

                const response = await fetch('https://app.xcloud.host/api/v1/sites/{uuid}/backup-settings', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});

const data = await response.json();
console.log(data);

                import requests

headers = {
    "Authorization": "Bearer YOUR_TOKEN"
}

response = requests.get("https://app.xcloud.host/api/v1/sites/{uuid}/backup-settings", headers=headers)

print(response.json())

                <?php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://app.xcloud.host/api/v1/sites/{uuid}/backup-settings',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
  'Authorization: Bearer YOUR_TOKEN'
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

                using System.Net.Http;

var client = new HttpClient();
var request = new HttpRequestMessage(new HttpMethod("GET"), "https://app.xcloud.host/api/v1/sites/{uuid}/backup-settings");
request.Headers.Add("Authorization", "Bearer YOUR_TOKEN");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

                import java.net.URI;
import java.net.http.*;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://app.xcloud.host/api/v1/sites/{uuid}/backup-settings"))
    .header("Authorization", "Bearer YOUR_TOKEN")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
```

## Response

```json

                {
    "success": true,
    "message": "Backup settings retrieved successfully.",
    "data": {
        "items": [
            {
                "uuid": "0c1f3a89-2c4e-4a73-9d4c-8b1f2a3d4e5f",
                "type": "full",
                "version": "1",
                "is_local": false,
                "status": "completed",
                "database": true,
                "files": true,
                "exclude_paths": null,
                "auto_backup": true,
                "auto_backup_frequency": "daily",
                "auto_incremental_backup": false,
                "auto_incremental_frequency": null,
                "auto_delete": true,
                "delete_after_days": 30,
                "time": "02:00",
                "incremental_time": null,
                "last_backup_at": "2026-05-15T02:00:00Z",
                "storage_provider": {
                    "uuid": "f8e7d6c5-b4a3-9281-7e6f-5d4c3b2a1f0e",
                    "provider": "s3",
                    "status": "connected"
                },
                "created_at": "2025-12-10T00:00:00Z",
                "updated_at": "2026-05-15T02:00:00Z"
            }
        ],
        "count": 1
    }
}

                {
    "success": false,
    "message": "Unauthenticated.",
    "data": null
}

                {
    "success": false,
    "message": "This action is unauthorized. Your token is missing the required scope.",
    "data": null
}

                {
    "success": false,
    "message": "Not found.",
    "data": null
}
```

Returns the backup settings configured for the site. A site can have multiple entries (typically one local and one remote). The storage provider's credentials are never exposed — only its UUID, provider name, and connection status. Requires the `read:sites` scope.

## Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `uuid` | string (uuid) | **Required** | UUID of the site |

## Responses

### 200 — List of backup settings

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean | Optional |  |
| `message` | string | Optional |  |
| `data` | object | Optional |  |
| `data` | object | Optional |  |
| `data.items` | array of object | Optional |  |
| `data.count` | integer | Optional |  |

```json

                {
    "success": true,
    "message": "Backup settings retrieved successfully.",
    "data": {
        "items": [
            {
                "uuid": "0c1f3a89-2c4e-4a73-9d4c-8b1f2a3d4e5f",
                "type": "full",
                "version": "1",
                "is_local": false,
                "status": "completed",
                "database": true,
                "files": true,
                "exclude_paths": null,
                "auto_backup": true,
                "auto_backup_frequency": "daily",
                "auto_incremental_backup": false,
                "auto_incremental_frequency": null,
                "auto_delete": true,
                "delete_after_days": 30,
                "time": "02:00",
                "incremental_time": null,
                "last_backup_at": "2026-05-15T02:00:00Z",
                "storage_provider": {
                    "uuid": "f8e7d6c5-b4a3-9281-7e6f-5d4c3b2a1f0e",
                    "provider": "s3",
                    "status": "connected"
                },
                "created_at": "2025-12-10T00:00:00Z",
                "updated_at": "2026-05-15T02:00:00Z"
            }
        ],
        "count": 1
    }
}
```

### 401 — Missing or invalid authentication token

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean | Optional |  |
| `message` | string | Optional |  |
| `data` | object | Optional |  |

```json

                {
    "success": false,
    "message": "Unauthenticated.",
    "data": null
}
```

### 403 — Token lacks the required scope

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean | Optional |  |
| `message` | string | Optional |  |
| `data` | object | Optional |  |

```json

                {
    "success": false,
    "message": "This action is unauthorized. Your token is missing the required scope.",
    "data": null
}
```

### 404 — Resource not found or not accessible to your [Team](https://betterdocs.shahrear.msf.bd/encyclopedia/team/)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean | Optional |  |
| `message` | string | Optional |  |
| `data` | object | Optional |  |

```json

                {
    "success": false,
    "message": "Not found.",
    "data": null
}
```