Forrester Total Economic Impactâ„¢ study finds Edwin AI delivered a 313% ROI for composite organization.

Read more

The Veeam Backup and Replication v13 REST API Monitoring package lets you monitor Veeam Backup and Replication (VBR) with LogicMonitor and gain visibility into the health, performance, and protection status of VBR infrastructure.

This Veeam VBR REST API monitoring package uses the Veeam VBR REST API to collect backup job, session health, repository capacity, proxy health, license, configuration backup, and Security and Compliance Analyzer metrics. The package helps identify failed or stale backup sessions, repository capacity issues, proxy availability problems, license consumption risks, configuration backup gaps, and actionable security compliance findings.

The package monitors the following:

  • Backup, backup copy, and replica jobs
  • Session health and failures
  • Repository and scale-out repository capacity
  • Proxy health
  • License status and consumption
  • Configuration backup protection
  • Security and Compliance Analyzer findings

This package is compatible with the following:

  • Veeam Backup and Replication 13
  • VBR REST API revision 1.3-rev1

For more information about the Veeam REST API, see Veeam Backup & Replication 13 from Veeam.

Requirements for Veeam Backup and Replication v13 REST API Monitoring

To use Veeam Backup and Replication v13 REST API Monitoring, you need the following:

  • A LogicMonitor user with the Install and Manage permissions for the resource group and relevant Collector in the Modules role permissions.
  • Collector access to the VBR server over HTTPS
  • VBR REST API enabled and reachable
  • LogicMonitor_Collector_Snippets DataSource imported, or Collector support for required snippets
  • Veeam account with permission to read required REST API endpoints

Important: Verify Collector trust for private or self-signed certificates during testing.

Adding Resources into Veeam Backup and Replication v13 REST API Monitoring

The Veeam Backup and Replication v13 REST API monitoring package uses the addCategory_Veeam_VBR PropertySource to identify VBR servers and assign the VeeamVBRRestAPI system category. All DataSources in the package apply to resources with this category.

This package uses the VBR REST API only and does not require the legacy PowerShell workflow.

Note: Running both REST API and legacy PowerShell packages can produce duplicate monitoring.

For more information, see Adding Resources.

Set or verify the following properties on the resource or parent group:

PropertyDescription
veeam.vbr.userVBR REST API username
veeam.vbr.passVBR REST API password

The following optional properties are also supported:

PropertyDefaultDescription
veeam.vbr.port9419REST API port
veeam.vbr.version1.3-rev1API revision override
veeam.vbr.timeout.ms30000API timeout in milliseconds
veeam.vbr.page.size100API page size
veeam.vbr.jobtypes.excludeNoneExcluded job types
veeam.vbr.session.lookback.hours48Session lookback window

Troubleshooting for Veeam Backup and Replication v13 REST API Monitoring

The following table outlines common troubleshooting guidance for the Veeam Backup and Replication v13 REST API monitoring package:

IssueResolution
Modules do not applyVerify system.categories includes VeeamVBRRestAPI
Authentication failsVerify veeam.vbr.user and veeam.vbr.pass are configured correctly
API requests return HTTP 403Verify the Veeam account has permission to access the requested endpoint
API requests time outVerify Collector connectivity to https://<vbr-host>:9419 and increase veeam.vbr.timeout.ms if needed
Collection fails after changing API versionRemove or correct veeam.vbr.version
Job instances are missingVerify veeam.vbr.jobtypes.exclude is not excluding returned job types
Session health appears staleIncrease veeam.vbr.session.lookback.hours to cover the expected backup cadence

To inspect the VBR API outside LogicMonitor, use the following:

https://<vbr-host>:9419/swagger/index.html

Import LogicModules

Install all Veeam Backup and Replication v13 REST API LogicModules from LogicMonitor Exchange.

If these LogicModules are already present, verify they are updated to the latest version.

Data collection automatically starts after the LogicModules are imported and required properties are configured.

For more information, see Module Installation.

LogicModules in Package

LogicMonitor’s package for Veeam Backup and Replication v13 REST API Monitoring consists of the following LogicModules:

Display NameTypeDescription
addCategory_Veeam_VBRPropertySourceIdentifies VBR servers and assigns the VeeamVBRRestAPI system category
veeam.vbrSnippetShared REST API authentication and request helper
Veeam_VBR_BackupJobsDataSourceMonitors primary backup job state and performance

Note: Some Veeam builds return valid backup jobs with job.type=Unknown
Veeam_VBR_BackupCopyJobsDataSourceMonitors backup copy job state and session metrics

Note: Backup copy jobs expose limited performance metrics.
Veeam_VBR_ReplicaJobsDataSourceMonitors replica job state and performance
Veeam_VBR_BackupJobs_SessionHealthDataSourceMonitors backup session freshness and failures

Note: Backup copy jobs expose limited performance metrics.
Veeam_VBR_BackupCopyJobs_SessionHealthDataSourceMonitors backup copy session freshness and failures
Veeam_VBR_ReplicaJobs_SessionHealthDataSourceMonitors replica session freshness and failures
Veeam_VBR_RepositoriesDataSourceMonitors repository availability and capacity

Note: Aggregate capacity totals can include shared backing storage.
Veeam_VBR_Repositories_ScaleOutDataSourceMonitors scale-out repository health and utilization

Note: Aggregate capacity totals can include shared backing storage.
Veeam_VBR_ProxiesDataSourceMonitors VBR proxy availability and state
Veeam_VBR_License_HealthDataSourceMonitors license status and consumption
Veeam_VBR_Configuration_BackupDataSourceMonitors configuration backup protection and retention
Veeam_VBR_Security_Compliance_ChecksDataSourceMonitors Security & Compliance Analyzer findings

When setting static datapoint thresholds on the various metrics tracked by this package’s DataSources, LogicMonitor follows the technology owner’s best practice KPI recommendations.

Recommendation: If necessary, adjust these predefined thresholds to meet the unique needs of your environment. For more information on tuning datapoint thresholds, see Static Thresholds for Datapoints.

14-day access to the full LogicMonitor platform