VBR REST API

Veeam Backup & Replication REST API allows you to query information about Veeam Backup & Replication entities and perform operations with these entities using HTTP requests and standard HTTP methods.

Category

Vulnerability Management

Pack

Veeam

Configuration parameters

• credentials — Username (required)
• url — Resource URL (required)
• insecure — Trust any certificate (not secure)
• proxy — Use system proxy settings
• http_request_timeout_sec — API Request Timeout (Seconds)
• api-version — API Version
• isFetch — Fetch incidents
• first_fetch — First Fetch Time
• fetch_configuration_backup_events — Fetch configuration backup events
• days_since_last_configuration_backup — Days Since Last Configuration Backup
• fetch_backup_repository_events — Fetch backup repository events
• backup_repository_free_space — Backup Repository Free Space (GB)
• backup_repository_events_per_request — Backup Repository Events Per Request
• fetch_malware_events — Fetch malware events
• malware_events_per_request — Malware Events Per Request
• fetch_security_analyzer_events — Fetch Security & Compliance Analyzer events
• fetch_sure_backup_events — Fetch SureBackup job events
• incidentFetchInterval — Incidents Fetch Interval
• incidentType — Incident type
• max_fetch —

Commands (31)

• veeam-vbr-compare-entra-id-item-properties — Compare Microsoft Entra ID Item Properties between restore points or production.
• veeam-vbr-create-malware-event — Create Malware Event.
• veeam-vbr-general-api-request — Sends a generic HTTP request to any VBR REST API endpoint.
• veeam-vbr-get-authorization-events — Get All Authorization Events.
• veeam-vbr-get-backup-object — Get Backup Object.
• veeam-vbr-get-configuration-backup — Get Configuration Backup.
• veeam-vbr-get-disk-publishing-mount-point — Gets information on a disk publishing mount point.
• veeam-vbr-get-entra-id-item-restore-points — Get Restore Points of Microsoft Entra ID Item.
• veeam-vbr-get-entra-id-items — Get Microsoft Entra ID Items. Browses Microsoft Entra ID items available in a backup.
• veeam-vbr-get-inventory-objects — Get Inventory Objects.
• veeam-vbr-get-job-states — Get All Job States.
• veeam-vbr-get-malware-events — Get All Malware Events.
• veeam-vbr-get-repository-states — Get All Repository States.
• veeam-vbr-get-restore-points — Get All Restore Points.
• veeam-vbr-get-security-analyzer-best-practices — Get Security & Compliance Analyzer Results.
• veeam-vbr-get-security-analyzer-last-run — Get Security & Compliance Analyzer last run details.
• veeam-vbr-get-session — Get Session.
• veeam-vbr-get-session-logs — Get Session Logs. Returns log records for the specified session.
• veeam-vbr-get-yara-rules — Get All YARA Rules.
• veeam-vbr-mount-entra-id-tenant — Mounts a Microsoft Entra ID tenant from its backup and starts a mount session required for restore.
• veeam-vbr-start-configuration-backup — Start Configuration Backup.
• veeam-vbr-start-disk-publishing — Start Disk Publishing. Publishes disk content from a restore point via the Data Integration API using ISCSITarget mount mode.
• veeam-vbr-start-instant-recovery — Start VM Instant Recovery to Original Location.
• veeam-vbr-start-instant-recovery-customized — Start Customized VM Instant Recovery.
• veeam-vbr-start-instant-recovery-hyperv-vm — Start Instant Recovery of Microsoft Hyper-V VM to original location.
• veeam-vbr-start-instant-recovery-hyperv-vm-customized — Start Instant Recovery of Microsoft Hyper-V VM to a customized location.
• veeam-vbr-start-malware-backup-scan — Starts a Scan Backup session.
• veeam-vbr-start-security-analyzer — Starts the Security & Compliance Analyzer scan. The command creates a new session and returns its details.
• veeam-vbr-start-vsphere-quick-backup — Start vSphere Quick Backup.
• veeam-vbr-stop-disk-publishing — Stops publishing of disk content and unmounts the published disks.
• veeam-vbr-unmount-entra-id-tenant — Stops the mount session for a Microsoft Entra ID tenant.