Skip to main content

Core Operations

Get Dashboard Data (Consolidated) - /api/dashboard​

  • Endpoint: /api/dashboard
  • Method: GET
  • Description: Retrieves all dashboard data in a single consolidated response, including server summaries, overall summary, and chart data.
  • Response: 
    {
      "serversSummary": [
        {
          "id": "server-id",
          "name": "Server Name",
          "lastBackupDate": "2024-03-20T10:00:00Z",
          "lastBackupStatus": "Success",
          "lastBackupDuration": "00:38:31",
          "lastBackupListCount": 10,
          "lastBackupName": "Backup Name",
          "lastBackupId": "backup-id",
          "backupCount": 15,
          "totalWarnings": 5,
          "totalErrors": 0,
          "availableBackups": ["v1", "v2", "v3"],
          "isBackupOverdue": false,
          "notificationEvent": "all",
          "expectedBackupDate": "2024-03-21T10:00:00Z",
          "expectedBackupElapsed": "2 hours ago",
          "lastOverdueCheck": "2024-03-20T12:00:00Z",
          "lastNotificationSent": "N/A"
        }
      ],
      "overallSummary": {
        "totalServers": 3,
        "totalBackups": 9,
        "totalUploadedSize": 2397229507,
        "totalStorageUsed": 43346796938,
        "totalBackupSize": 126089687807,
        "overdueBackupsCount": 2,
        "secondsSinceLastBackup": 7200
      },
      "chartData": [
        {
          "date": "20/03/2024",
          "isoDate": "2024-03-20T10:00:00Z",
          "uploadedSize": 1024000,
          "duration": 45,
          "fileCount": 1500,
          "fileSize": 2048000,
          "storageSize": 3072000,
          "backupVersions": 5
        }
      ]
    }
  • Error Responses:
    • 500: Server error fetching dashboard data
  • Notes:
    • This endpoint consolidates the previous /api/servers-summary endpoint (which has been removed)
    • The overallSummary field contains the same data as /api/summary (which is maintained for external applications)
    • The chartData field contains the same data as /api/chart-data/aggregated (which still exists for direct access)
    • Provides better performance by reducing multiple API calls to a single request
    • All data is fetched in parallel for optimal performance
    • The secondsSinceLastBackup field shows the time in seconds since the last backup across all servers

Get All Servers - /api/servers​

  • Endpoint: /api/servers
  • Method: GET
  • Description: Retrieves a list of all servers with their basic information. Optionally includes backup information.
  • Authentication: Requires valid session and CSRF token
  • Query Parameters:
    • includeBackups (optional): Set to true to include backup information for each server
  • Response (without parameters): 
    [
      {
        "id": "server-id",
        "name": "Server Name",
        "alias": "Server Alias",
        "note": "Additional notes about the server"
      }
    ]
  • Response (with includeBackups=true): 
    [
      {
        "id": "server-id",
        "name": "Server Name",
        "backupName": "Backup Name",
        "server_url": "http://localhost:8200",
        "alias": "Server Alias",
        "note": "Additional notes about the server",
        "hasPassword": true
      }
    ]
  • Error Responses:
    • 401: Unauthorized - Invalid session or CSRF token
    • 500: Server error fetching servers
  • Notes:
    • Returns server information including alias and note fields
    • When includeBackups=true, returns server-backup combinations with URLs and password status
    • Consolidates the previous /api/servers-with-backups endpoint (which has been removed)
    • Used for server selection, display, and configuration purposes
    • Includes hasPassword field to indicate if server has stored password

Get Server Details - /api/servers/:id​

  • Endpoint: /api/servers/:id
  • Method: GET
  • Description: Retrieves information about a specific server. Can return basic server info or detailed information including backups and chart data.
  • Authentication: Requires valid session and CSRF token
  • Parameters:
    • id: the server identifier
  • Query Parameters:
    • includeBackups (optional): Set to true to include backup data
    • includeChartData (optional): Set to true to include chart data
  • Response (without parameters): 
    {
      "id": "server-id",
      "name": "Server Name",
      "alias": "Server Alias",
      "note": "Additional notes about the server",
      "server_url": "http://localhost:8200"
    }
  • Response (with parameters): 
    {
      "id": "server-id",
      "name": "Server Name",
      "alias": "Server Alias",
      "note": "Additional notes about the server",
      "server_url": "http://localhost:8200",
      "backups": [
        { ... }
      ],
      "chartData": [
        { ... }
      ]
    }
  • Error Responses:
    • 401: Unauthorized - Invalid session or CSRF token
    • 404: Server not found
    • 500: Server error fetching server details
  • Notes:
    • Returns basic server information when no query parameters are provided
    • Setting either includeBackups or includeChartData to true returns full server data including backups and chartData
    • Used for server settings and detail views

Update Server - /api/servers/:id​

  • Endpoint: /api/servers/:id
  • Method: PATCH
  • Description: Updates server details including alias, note, and server URL.
  • Authentication: Requires valid session and CSRF token
  • Parameters:
    • id: the server identifier
  • Request Body: 
    {
      "server_url": "http://localhost:8200",
      "alias": "Server Alias",
      "note": "Additional notes about the server"
    }
  • Response: 
    {
      "message": "Server updated successfully",
      "serverId": "server-id",
      "server_url": "http://localhost:8200",
      "alias": "Server Alias",
      "note": "Additional notes about the server"
    }
  • Error Responses:
    • 401: Unauthorized - Invalid session or CSRF token
    • 404: Server not found
    • 500: Server error during update
  • Notes:
    • Updates server alias, note, and server URL
    • All fields are optional
    • Empty strings are allowed for all fields

Delete Server - /api/servers/:id​

  • Endpoint: /api/servers/:id

  • Method: DELETE

  • Description: Deletes a server and all its associated backups.

  • Authentication: Requires valid session and CSRF token

  • Parameters:

    • id: the server identifier

  • Response:

    {
      "message": "Successfully deleted server and 15 backups",
      "status": 200,
      "changes": {
        "backupChanges": 15,
        "serverChanges": 1
      }
    }

  • Error Responses:

    • 401: Unauthorized - Invalid session or CSRF token
    • 404: Server not found
    • 500: Server error during deletion

  • Notes:

    • This operation is irreversible
    • All backup data associated with the server will be permanently deleted
    • The server record itself will also be removed
    • Returns count of deleted backups and servers

Get Server Data with Overdue Info - /api/detail/:serverId​

  • Endpoint: /api/detail/:serverId

  • Method: GET

  • Description: Retrieves detailed server information including overdue backup status.

  • Parameters:

    • serverId: the server identifier

  • Response:

    {
      "server": {
        "id": "server-id",
        "name": "Server Name",
        "backups": [...]
      },
      "overdueBackups": [
        {
          "serverName": "Server Name",
          "backupName": "Backup Name",
          "lastBackupDate": "2024-03-20T10:00:00Z",
          "lastNotificationSent": "2024-03-20T12:00:00Z",
          "notificationEvent": "all",
          "expectedBackupDate": "2024-03-21T10:00:00Z",
          "expectedBackupElapsed": "2 hours ago"
        }
      ],
      "lastOverdueCheck": "2024-03-20T12:00:00Z"
    }

  • Error Responses:

    • 404: Server not found
    • 500: Server error fetching server details

  • Notes:

    • Returns server data with overdue backup information
    • Includes overdue backup details and timestamps
    • Used for overdue backup management and monitoring

Get Duplicate Servers - /api/servers/duplicates​

  • Endpoint: /api/servers/duplicates
  • Method: GET
  • Description: Retrieves a list of duplicate servers based on machine ID. Duplicate servers are servers that share the same machine ID but are stored as separate records in the database.
  • Authentication: Requires valid session, CSRF token, and administrator access
  • Response: 
    [
      {
        "machineId": "machine-id-123",
        "servers": [
          {
            "id": "server-id-1",
            "name": "Server Name 1",
            "alias": "Server Alias 1",
            "server_url": "http://localhost:8200",
            "backupCount": 5
          },
          {
            "id": "server-id-2",
            "name": "Server Name 2",
            "alias": "Server Alias 2",
            "server_url": "http://localhost:8200",
            "backupCount": 3
          }
        ]
      }
    ]
  • Error Responses:
    • 401: Unauthorized - Invalid session or CSRF token
    • 403: Administrator access required
    • 500: Server error fetching duplicate servers
  • Notes:
    • Only administrators can access this endpoint
    • Returns groups of servers that share the same machine ID
    • Each group contains all servers with the same machine ID
    • Used for identifying and merging duplicate server records
    • Includes server details and backup counts for each duplicate

Merge Servers - /api/servers/merge​

  • Endpoint: /api/servers/merge
  • Method: POST
  • Description: Merges multiple servers into a target server. All backups from the source servers are transferred to the target server, and the source servers are deleted.
  • Authentication: Requires valid session, CSRF token, and administrator access
  • Request Body: 
    {
      "oldServerIds": ["server-id-1", "server-id-2"],
      "targetServerId": "server-id-3"
    }
  • Response: 
    {
      "success": true,
      "message": "Successfully merged 2 server(s) into target server"
    }
  • Error Responses:
    • 400: Invalid request body, missing required fields, or target server is in the list of servers to merge
    • 401: Unauthorized - Invalid session or CSRF token
    • 403: Administrator access required
    • 500: Server error during merge operation
  • Notes:
    • Only administrators can perform merge operations
    • The target server must not be in the list of servers to merge
    • All backups from source servers are transferred to the target server
    • Source servers are deleted after successful merge
    • This operation is irreversible
    • Used for consolidating duplicate server records
    • Validates that oldServerIds is a non-empty array
    • Validates that targetServerId is provided and is a string