Druva MSP icon

Druva MSP

Interact with the Druva MSP API

Actions79

Backup Health Summary → Get Backup Health by Customer

AI-generated

Overview

This node operation retrieves backup health summary data filtered by customer(s) and date criteria. It is useful for MSPs or administrators who want to monitor the backup status of their customers' endpoint devices over specific or relative date ranges. For example, it can be used to generate reports showing customers with critical or warning backup statuses within the last 30 days or a custom date range.

Use Case Examples

  1. Generate a backup health report for all customers for the last 30 days.
  2. Get backup health summary for specific customers between two specific dates.
  3. Filter and return only customers with critical backup failures in the current month.

Properties

Name Meaning
Date Selection Method Choose whether to filter backup status records by last backup date, with options for all dates, specific dates, or relative date ranges.
Start Date Start of the date range to filter backup records (required if Specific Dates is selected).
End Date End of the date range to filter backup records (required if Specific Dates is selected).
Date Range Predefined relative date range to filter backup records (required if Relative Date Range is selected).
Filter by Customers Whether to restrict results to specific customer IDs.
Customer IDs List of customer IDs to include in the health summary (required if filtering by customers).
Critical Failure Threshold (%) Percentage of failed endpoint devices above which the customer is marked as critical (range 0–100).
Return Level Controls which customers are included in the output based on their health status.
Wrap Output Items When enabled, wraps all output items into a single item containing an array to prevent the next node from executing multiple times.
Wrapper Property Name The property name to use for the wrapped array of items in the output. Default is "items".

Output

JSON

  • customerId - The unique identifier of the customer.
  • customerName - The name of the customer.
  • backupStatus - Overall backup health status for the customer (e.g., healthy, warning, critical).
  • failedEndpointPercentage - Percentage of endpoint devices that have failed backups.
  • lastBackupDate - The date of the most recent backup for the customer.
  • details - Additional details or metrics related to the backup health summary.

Dependencies

  • Druva MSP API
  • An API key credential for authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has necessary permissions to access backup health data.
  • Verify that the customer IDs provided (if filtering by customers) are valid and exist in the system.
  • Check date inputs for correct format and logical consistency (start date should not be after end date).
  • If no data is returned, verify that the selected date range and filters actually contain backup health records.
  • Common error messages may include authentication failures, invalid parameters, or API rate limits. Review error messages and adjust configuration accordingly.

Links

Discussion