Overview
The Druva Itemized Consumption collector retrieves itemized consumption data from the Druva MSP platform using the Druva MSP Reporting API.
This collector provides visibility into customer-level product consumption across Druva service plans, enabling managed service providers to validate usage allocations, reconcile consumption, and bill customers within Varibill.
The collector retrieves unrated consumption data, meaning no monetary values are supplied by the source system. Pricing and billing calculations are applied within Varibill based on configured contracts and pricing rules.
This is a historically capable collector, meaning each execution retrieves consumption data for a configurable date range in the past, rather than a snapshot of the current state.
For general instructions on creating and running Source Collectors, see: Configuring a New Cloud Source Collector
Collector Summary
| Field | Value |
|---|---|
| Source Collector Name | Druva Itemized Consumption - Version 1.0 |
| Collection Behavior | Historically Capable |
| Rating Model | Unrated |
| Vendor Name | Druva |
| Product | Druva MSP Platform |
| Purpose | Retrieves itemized consumption data from the Druva MSP platform for billing and validation within Varibill |
About Druva
Druva is a cloud data protection and management company that provides backup, disaster recovery, archival, and data governance solutions delivered as a service. Druva’s platform eliminates the need for on-premises backup infrastructure by providing a fully managed, cloud-native approach to protecting data across endpoints, SaaS applications, and cloud workloads.
The Druva MSP platform enables managed service providers (MSPs) to deliver Druva’s data protection services to their customers. MSPs use the platform to manage customer tenants, provision service plans, monitor consumption, and track usage across product modules such as Microsoft 365, Google Workspace, and endpoint backup.
Data Collected
The Druva Itemized Consumption - Version 1.0 collector retrieves unrated itemized consumption data from the Druva MSP Reporting API. Each record represents a usage line item for a specific customer, product module, and usage category within a given date.
The collector captures the following data for each consumption record:
- Customer details — customer account name and global identifier
- Product details — product name, edition, product module name, and service plan name
- Usage details — usage description (for example, Active Users, Shared Mailbox, Preserved Users), usage amount, and usage unit
- Date — the date the consumption was recorded
The following filtering is applied during processing:
- Only records with a non-zero usage amount are included (zero-quantity records are excluded)
The time window covered by each collection run is configurable using the Date Offset and Date Range parameters, enabling the collector to align with your billing cycle and to recover data from prior periods where needed.
Note: The same customer may appear in multiple records across different dates, product modules, and usage categories within a single collection run. Each record represents consumption for that specific combination on that date.
Prerequisites
Before configuring this collector, ensure that:
- You have a Druva MSP account with access to the Druva MSP platform
- You have generated API credentials (Client ID and Secret Key) from the Druva MSP console
- You have noted the Druva API host URL (for example,
https://apis.druva.com) - You have access to the Varibill Source Collector configuration screen
Tip: API credentials are generated in the Druva MSP console. Contact your Druva administrator if you do not have credentials or are unsure where to find them.
Warning! The Druva Secret grants API access to your Druva MSP environment. Store it securely and do not share it. The secret is masked in the Varibill UI once saved. If the secret is compromised, revoke and regenerate it immediately in the Druva MSP console.
Configuration Parameters
The parameters below are entered when configuring the collector in Varibill. They are grouped by function.
Connection Parameters
These parameters identify and authenticate against your Druva MSP environment. The collector uses HTTP Basic Authentication with the Druva Client ID and Secret Key to obtain an OAuth access token.
| Parameter | What it is | Where to find it |
|---|---|---|
| Druva Host | The base URL of the Druva API | Your Druva API host URL. Format: https://apis.druva.com
(include https://, no trailing slash) |
| Druva Username | The Client ID used for API authentication | Druva MSP console → API Credentials. See Getting Started with Druva MSP API |
| Druva Secret | The Secret Key used for API authentication | Druva MSP console → API Credentials |
Warning! The Druva Secret is a sensitive credential. It is masked in the Varibill UI once saved. If it is compromised, revoke and regenerate it immediately in the Druva MSP console.
Billing Parameters
| Parameter | What it is | Default |
|---|---|---|
| Product Identifier Code | A prefix applied to the beginning of each Product Identifier submitted to Varibill. The Product Identifier is constructed as the prefix followed by components from the Druva consumption record. | Druva# |
Note: The Product Identifier submitted to Varibill is constructed in the format:
{Product Identifier Code}{editionName}#{productId}#{productModuleId}#{servicePlanId}#{tenantType}#{usageDescription}
For example:
Druva#Enterprise#2#2#1976#Commercial#Active Users
The Record Identifier is the usage description (for example,
Active Users, Shared Mailbox,
Preserved Users).
The Client Identifier is the Druva customer global ID.
The Unique Identifier is constructed as
{customerGlobalId}#{ProductIdentifier}.
Ensure your Varibill product configuration accounts for these formats.
Date Range Parameters
These parameters define the time window of consumption data collected on each run.
| Parameter | What it is | Default |
|---|---|---|
| Date Offset | The number of days back from today to start the collection window | 1 |
| Date Range | The number of days to collect, starting from the offset date | 3 |
| Date Format | The date format used for date calculations | yyyy-MM-dd |
Note: For example, with Date Offset = 1
and Date Range = 3, the collector will
retrieve consumption data for the period beginning 1 day ago and
spanning 3 days. Adjust these values to match your billing cycle and
scheduling frequency.
Operational Parameters
These parameters control file management behavior.
| Parameter | What it is | Default |
|---|---|---|
| Delete data files older than | The number of days after which locally stored collection files are automatically deleted | 62 |
| Maximum number of records per file | The maximum number of records written to a single output file before a new file is started. Must be between 1,000 and 50,000. | 10000 |
Druva References
The following resources may assist with locating values or configuring your Druva API access.
Druva Documentation (External)
Note: Druva documentation is provided for reference. Steps and interface labels may vary depending on your Druva MSP account configuration and permissions.
Configuration Steps
Step 1: Prepare Your Druva MSP Environment
- Log in to the Druva MSP console.
- Navigate to the API Credentials section.
- Generate or locate your Client ID and Secret Key.
- Note the API host URL (for example,
https://apis.druva.com).
Step 2: Configure the Collector in Varibill
In the Varibill User Interface, open the Source Collector configuration screen.
Enter the required field values under the Details tab:
- Hosting Provider: Select Varibill Cloud
- Source Collector Name: Select Druva Itemized Consumption - Version 1.0
Enter the connection parameters:
- Druva Host: The base URL of the Druva API (for
example,
https://apis.druva.com) - Druva Username: The Client ID from the Druva MSP console
- Druva Secret: The Secret Key from the Druva MSP console
- Druva Host: The base URL of the Druva API (for
example,
Configure the billing parameters:
- Product Identifier Code: The prefix to apply to
Product Identifiers (for example,
Druva#)
- Product Identifier Code: The prefix to apply to
Product Identifiers (for example,
Set the date range parameters:
- Date Offset: The number of days back from today to start the collection window
- Date Range: The number of days to collect from the offset date
Save the collector configuration.
Step 3: Run the Collector
Run or schedule the collector according to your standard Source Collector execution process.
For detailed instructions, see: Configuring a New Cloud Source Collector
Troubleshooting
If the collector fails to connect to the Druva API, verify that:
- The Druva Host URL is correct and includes
https://with no trailing slash. - The Druva Username (Client ID) is correct.
- The Druva Secret (Secret Key) is valid and has not been revoked or regenerated.
- No firewall or IP restriction rules are blocking the Varibill collector’s IP address from reaching the Druva API host.
If the collector connects successfully but returns no data, verify that:
- The Date Offset and Date Range values cover a period in which consumption data exists.
- Your Druva MSP account has active customer tenants with consumption activity.
- The Druva MSP platform is accessible and returning data correctly.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article