外部API

这些端点旨在供其他应用程序和集成使用，例如首页。

获取总体摘要 - `/api/summary`

端点: /api/summary
方法: GET
描述: 检索所有服务器上的所有备份操作的摘要。

响应:

{
  "totalServers": 3,
  "totalBackupsRuns": 9,
  "totalBackups": 9,
  "totalUploadedSize": 2397229507,
  "totalStorageUsed": 43346796938,
  "totalBackupSize": 126089687807,
  "overdueBackupsCount": 2,
  "secondsSinceLastBackup": 7200
}

错误响应:
- 500: 服务器错误，获取摘要数据
注释:
- 在版本 0.5.x 中，字段 totalBackupedSize 被替换为 totalBackupSize
- 在版本 0.7.x 中，字段 totalMachines 被替换为 totalServers
- 字段 overdueBackupsCount 显示当前逾期备份的数量
- 字段 secondsSinceLastBackup 显示自上次备份以来所经过的时间（以秒为单位）
- 如果数据获取失败，则返回带有零的回退响应
- 注释: 对于内部仪表盘使用，请考虑使用 /api/dashboard，它包含此数据以及其他信息

获取最新备份 - `/api/lastbackup/:serverId`

端点: /api/lastbackup/:serverId
方法: GET
描述: 检索特定服务器的最新备份信息。
参数:
- serverId: 服务器标识符（ID 或名称）

注释

服务器标识符必须进行 URL 编码。

响应:

{
  "server": {
    "id": "unique-server-id",
    "name": "Server Name",
    "backup_name": "Backup Name",
    "backup_id": "backup-id",
    "created_at": "2024-03-20T10:00:00Z"
  },
  "latest_backup": {
    "id": "backup-id",
    "server_id": "unique-server-id",
    "name": "Backup Name",
    "date": "2024-03-20T10:00:00Z",
    "status": "Success",
    "warnings": 0,
    "errors": 0,
    "messages": 150,
    "fileCount": 249426,
    "fileSize": 113395849938,
    "uploadedSize": 331318892,
    "duration": "00:38:31",
    "duration_seconds": 2311.6018052,
    "durationInMinutes": 38.52669675333333,
    "knownFileSize": 27203688543,
    "backup_list_count": 10,
    "messages_array": ["message1", "message2"],
    "warnings_array": ["warning1"],
    "errors_array": [],
    "available_backups": ["v1", "v2", "v3"]
  },
  "status": 200
}

错误响应:
- 404: 服务器未找到
- 500: 服务器内部错误
注释:
- 在版本 0.7.x 中，响应对象键从 machine 更改为 server
- 服务器标识符可以是 ID 或名称
- 如果没有备份，则返回 null 的 latest_backup
- 包括缓存控制头以防止缓存

获取最新备份 - `/api/lastbackups/:serverId`

端点: /api/lastbackups/:serverId
方法: GET
描述: 检索特定服务器上所有配置的备份（例如“文件”，“数据库”）的最新备份信息。
参数:
- serverId: 服务器标识符（ID 或名称）

注释

服务器标识符必须进行 URL 编码。

响应:

{
  "server": {
    "id": "unique-server-id",
    "name": "Server Name",
    "backup_name": "Default Backup",
    "backup_id": "backup-id",
    "created_at": "2024-03-20T10:00:00Z"
  },
  "latest_backups": [
    {
      "id": "backup1",
      "server_id": "unique-server-id",
      "name": "Files",
      "date": "2024-03-20T10:00:00Z",
      "status": "Success",
      "warnings": 0,
      "errors": 0,
      "messages": 150,
      "fileCount": 249426,
      "fileSize": 113395849938,
      "uploadedSize": 331318892,
      "duration": "00:38:31",
      "duration_seconds": 2311.6018052,
      "durationInMinutes": 38.52669675333333,
      "knownFileSize": 27203688543,
      "backup_list_count": 10,
      "messages_array": "[\"message1\", \"message2\"]",
      "warnings_array": "[\"warning1\"]",
      "errors_array": "[]",
      "available_backups": ["v1", "v2", "v3"]
    },
    {
      "id": "backup2",
      "server_id": "unique-server-id",
      "name": "Databases",
      "date": "2024-03-20T11:00:00Z",
      "status": "Success",
      "warnings": 1,
      "errors": 0,
      "messages": 75,
      "fileCount": 125000,
      "fileSize": 56789012345,
      "uploadedSize": 123456789,
      "duration": "00:25:15",
      "duration_seconds": 1515.1234567,
      "durationInMinutes": 25.25205761166667,
      "knownFileSize": 12345678901,
      "backup_list_count": 5,
      "messages_array": ["message1"],
      "warnings_array": ["warning1"],
      "errors_array": [],
      "available_backups": ["v1", "v2"]
    }
  ],
  "backup_jobs_count": 2,
  "backup_names": ["Files", "Databases"],
  "status": 200
}

错误响应:
- 404: 服务器未找到
- 500: 服务器内部错误
注释:
- 在版本 0.7.x 中，响应对象键从 machine 更改为 server，并且字段 backup_types_count 被重命名为 backup_jobs_count
- 服务器标识符可以是 ID 或名称
- 返回服务器具有的每个备份作业（backup_name）的最新备份
- 与 /api/lastbackup/:serverId 不同，后者仅返回服务器的单个最新备份（与备份作业无关）
- 包括缓存控制头以防止缓存

上传备份数据 - `/api/upload`

端点: /api/upload
方法: POST
描述: 上传服务器的备份操作数据。支持检测重复备份运行并发送通知。

请求体: Duplicati 发送的 JSON，包含以下选项:

--send-http-url=http://my.local.server:9666/api/upload
--send-http-result-output-format=Json
--send-http-log-level=Information

响应:
```
{
  "success": true
}
```
错误响应:
- 400: Extra 或 Data 部分缺少必需字段，或 MainOperation 无效
- 409: 备份数据重复（忽略）
- 500: 处理备份数据时服务器错误
注意:
- 只处理备份操作（MainOperation 必须是 "备份"）
- 验证 Extra 部分的必需字段：machine-id、machine-name、backup-name、backup-id
- 验证 Data 部分的必需字段：ParsedResult、BeginTime、持续时间
- 自动检测重复备份运行并返回 409 状态
- 备份插入成功后发送通知（如果配置了）
- 在开发模式下将请求数据记录到项目根目录的 data 目录中的文件中用于调试
- 使用事务以确保数据一致性

获取总体摘要 - /api/summary​

获取最新备份 - /api/lastbackup/:serverId​

获取最新备份 - /api/lastbackups/:serverId​

上传备份数据 - /api/upload​

获取总体摘要 - `/api/summary`

获取最新备份 - `/api/lastbackup/:serverId`

获取最新备份 - `/api/lastbackups/:serverId`

上传备份数据 - `/api/upload`