This plugin integrates with the Veeam Backup and Replication (BR) API, which is part of a Veeam BR server/installation typically running on a enterprise-local virtual machine.

Note: The Veeam BR API does not provide access to the raw certificate. Therefore, this plugin records certificate attributes only and does not store the complete certificate content.

Before You Start

You need four pieces of information:

  1. Veeam REST API base URL - this should usually be https://<server/IP>:9419/api. The 9419 port is a fixed value and cannot be changed in the current (July 2026) version of Veeam BR.

  2. API version - as of this writing (July 2026), this should be set to "1.3-rev1"
  3. API administrator username - User name for a user with the Veeam Backup Adminstrator role in your Veeam installation. For a Windows installation this is likely "Administrator". For a Linux installation, this is likely "veeamadmin"
  4. API administrator password - Password for above user, likely set during Veeam installation.

You may also need the PEM certificate for your Veeam server or issuing CA if the API is protected by a self-signed or privately issued TLS certificate.

Required Access

The account used by the plugin must be able to authenticate to the Veeam REST API and read the resources queried by the plugin.

At minimum, the account must be able to access:

  • /oauth2/token
  • /v1/serverCertificate
  • /v1/kmsServers
  • /v1/credentials
  • /v1/encryptionPasswords

If the account can log in but lacks permission to one of the scan endpoints, the scan will fail with an API error. This is why a user with Administrator role is required input - an Administrator is authorized for any endpoint.