Connecting the VBR for Home Assistant Integration to a v13 VSA

If you’re using the Veeam Backup & Replication Integration for Home Assistant and the Veeam Software Appliance (VSA), it is highly recommended you connect the two using a dedicated service account. This improves security, avoids MFA conflicts, and aligns with best practices for automation and API access.

This guide walks through the process.

Why Use a Service Account?

Using a service account provides:

• Stable API authentication (no password rotations tied to a user)
• Optional MFA bypass for automation workflows
• Clear audit separation from human admins
• Safer long-term integration with Home Assistant and other tooling

In production environments (especially service provider or lab environments like mine running Veeam 13 + API automation), this is the recommended approach.

Part 1: Create a Local User in the Veeam Host Management Console (VSA)

First, create the underlying OS-level user on the Veeam Backup Server Appliance.

Steps

1. Open the Host Management Console: https://<veeam-server>:10443
2. Log in with your appliance administrator account
3. Navigate to: Security → Users and Roles

4. Click Add

5. Enter:
   • Username: ha-veeam (example)
   • Password: (DISA STIG compliant)
   • Description: Home Assistant Service Account

6. Click Next
7. Set the role to: Service Account

8. Click Next

9. Click Finish

This creates the appliance-level user required for API-backed services.

Part 2: Grant REST API Permissions in the Veeam Web UI

Now you must grant the user proper Veeam Backup & Replication permissions. Without this step, the API will authenticate but fail authorization.

Steps

1. Open the Veeam Web UI: https://<veeam-server>
2. Log in as a Veeam administrator
3. Go to: Configuration → Users & Roles

4. Click Add

5. Configure:
   • Type: User
   • Name: username (the same user created in Part 1)
   • Role: Veeam Backup Administrator
   • If MFA is enabled: Select “This is a service account (disables multi-factor authentication)”

6. Click OK

NOTE: Other roles such as “Veeam Backup Operator” can be used but some features/functions may be missing. For example, only “Veeam Backup Administrator” users can access the APIs to get VBR server and license information.

Part 3: Add the Service Account to Home Assistant

Once the account is created and authorized:

1. Open Home Assistant
2. Navigate to:
3. Settings → Devices & Services → Add Integration
4. Select the Veeam Backup & Replication integration
5. Enter:
   • Host: <veeam-server>
   • Port: 9419 (unless changed from default)
   • Username: ha-veeam
   • Password: (service account password)
   • Uncheck “Verify SSL certificate” if needed
   • API Version: v1.3-rev1 (for Veeam 13.0.1)

After successful authentication, Home Assistant will begin discovering:

• Backup jobs
• Repositories
• Alerts and status sensors
• VBR Server Metrics
• License Information

Security Best Practices

For proper security on your VBR server:

• Do NOT use your personal admin account
• Use a unique password for the service account
• Restrict access to API ports (9419/443) via firewall or reverse proxy
• Avoid domain admin accounts unless required
• Enable multi-user authentication