Veeam API Integration Guide
| KB ID: | 4311 |
| Product: | Veeam Backup for Google Cloud Veeam Backup for Microsoft 365 Veeam Disaster Recovery Orchestrator Veeam ONE Veeam Backup & Replication Veeam Backup for AWS Veeam Backup for Microsoft Azure Veeam Service Provider Console Veeam Cloud Connect |
| Published: | 2022-05-16 |
| Last Modified: | 2022-05-16 |
Purpose
This article documents the methods and capabilities of API integration with Veeam's products.
| API | Description | Reference | Example |
Integration via PowerShell |
|||
| Veeam Backup & Replication | Full administrative, query, and operational control (equivalent to the administrative console and UI functionality) |
VBR Powershell | Getting Started Code Samples |
| Veeam Data Integration API | VBR PowerShell module subset. Presents Veeam backup(s) as block storage mounts for filesystem-level interrogation | Veeam Data Integration API | Restore Point Comparison |
| Veeam Explorers | Application-level item restore and export for Active Directory, SQL, Oracle, Exchange, SharePoint, Teams1 | Veeam Explorers Powershell | Initiate Windows File-level Restore |
| Veeam Cloud Connect | VBR PowerShell module subset. Full administrative, query, and operational control for the service provider (multi-tenant) VBR extensions | VCC Powershell | Insider Protection Check ?Example requires access to the Veeam Cloud & Service Providers Forum section. |
| Veeam Backup for Microsoft 365 | Full administrative, query, and operational control (equivalent to the product’s console UI and Veeam Explorers functionality) |
VBM365 Powershell | Remove Repository Data for Select Users |
Integration via RestAPI |
|||
| Veeam Backup & Replication | VBR infrastructure configuration, administration, and query. Note: Limited functionally, not equivalent to corresponding VBR Powershell API. |
VBR RestAPI | Simple PHP Dashboard |
| Veeam Backup Enterprise Manager | Federated VBR instance query and basic administration | EM RestAPI | Backup Job Status |
| Veeam Backup for Microsoft 365 | Full administrative, query, and configuration control | VBM RestAPI | Self-service Portal |
| Veeam ONE | Reporting and infrastructure query | VONE RestAPI | Integration Sample |
| Veeam Backup for Microsoft Azure | Cloud-native backup appliance administrative, query, and operational control (equivalent to console functionality) | Azure RestAPI | -- |
| Veeam Backup for AWS | AWS RestAPI | Grafana Dashboard for AWS | |
| Veeam Backup for Google Cloud | GCP RestAPI | -- | |
| Veeam Service Provider Console | Service provider (multi-tenant) infrastructure and remote management administrative, query, and operational control (equivalent to console functionality) |
VCSP Console RestAPI | Retrieve Tenant Session Status |
| Veeam Disaster Recovery Orchestrator | Orchestrator query and operational control (no administrative functions) |
VDRO RestAPI | Run Failover if VM Down |
Secure Restore AntiVirus Integration |
|||
| Veeam Backup & Replication | Not an API per se but rather a method by which 3rd party scanning applications may be integrated to perform malware detection on mounted backups for Secure Restore processing | Secure Restore XML Guide | ESET |
Click here to send feedback regarding this KB, or suggest content for a new KB.
To report a typo on this page, highlight the typo with your mouse and press CTRL + Enter.
To report a typo on this page, highlight the typo with your mouse and press CTRL + Enter.