Veeam API
Connect OverView to Veeam Backup & Replication via the REST API to retrieve backup job status and protected machines
The Veeam Backup & Replication API connector allows OverView to retrieve your backup inventory, job status, and protected machines directly from your Veeam platform.
Objective
The connector retrieves the following information:
- Backup inventory and recovery points
- Backup job status (success, failures, warnings)
- Protected machines and backup coverage
Prerequisites
- Veeam Backup & Replication v12 or later
- A Veeam Backup Administrator account — required by the Veeam REST API
- Port 9419 open between OverView and the VBR server
Why an administrator account? Veeam does not currently offer a read-only role for its REST API: authentication officially requires the Veeam Backup Administrator role. Lesser roles such as Backup Viewer are not supported for API access and fail on some endpoints depending on the version. Veeam has announced that role-based access control will be extended to the REST API in a future release. In the meantime, we recommend a dedicated service account with a strong password (see below).
Information to provide in OverView
Contact OverSOC support to configure this connector. You will need to provide:
| Field | Description |
|---|---|
| Server URL | URL of the VBR server REST API (e.g. https://vbr-server.example.com:9419) |
| Username | Veeam Backup Administrator account username |
| Password | Account password |
Procedure
Prepare a service account
Veeam REST API authentication uses an existing user account. We recommend creating a dedicated service account rather than using a personal administrator account:
- Open the Veeam Backup & Replication console.
- Go to Users and Roles (menu ☰ > Users and Roles).
- Add the service account and assign it the Veeam Backup Administrator role.
Verify network access
The OverView platform must be able to reach port 9419 on your VBR server. Check that your firewall allows inbound connections on this port from the OverView IP range — contact OverSOC support for the current IP range.
Official documentation
Alternative: file import through DropPoint
The API access described above is the recommended method for this connector. Where it is not available (a segregated network, a version or licence without API, an export you already produce), OverView accepts file exports, to be uploaded to the bucket dedicated to Veeam Backup & Replication.
Bucket : s3://veeam/
Example : s3://veeam/export.csv
The procedure is described in the OverView DropPoint guide: generating credentials, configuring the client, then sending files from the OverView web interface, the AWS CLI or an SDK. Its examples come pre-filled with this bucket when you follow this link.