> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Connecting Veeam Backup & Replication to Neo

> Publish a client's backup server REST API, give Neo a user, and save it in Neo

You connect Veeam Backup & Replication once for each client, with four values for that client's backup server: its REST API address, its version, and the user name and password Neo signs in with.

## Before you start

* Neo works with **Veeam Backup & Replication 12.0 or later**. Its REST API runs on the backup server, on port **9419** unless it was changed at install.
* Neo reaches the server over the internet. Its REST API must answer on **HTTPS** at a public address, with a certificate from a public certificate authority. The server's own self-signed certificate is not enough: publish the API through a reverse proxy that has such a certificate, or install one on the backup server.

### Publish only the REST API

Put a reverse proxy at the network edge of the site that runs the backup server. Set it to:

* answer on a public name over HTTPS, with a certificate from a public certificate authority;
* forward only paths under `/api/` to the backup server's REST API port (9419 by default), and refuse every other path;
* accept connections only from [Neo's addresses](https://docs.neoagent.io/integrations/ip-whitelisting.md);
* pass the `Authorization` and `x-api-version` headers through unchanged.

Save the proxy's public address in Neo.

## 1. Give Neo a user on the backup server

**1. Create a user for Neo**

Create a Windows or domain account for Neo on the backup server, such as `ACME\neo-backup`, with a password of its own.

**2. Give it a role**

In the Veeam Backup & Replication console, open **Users and Roles** and add that account with the role your agents need: **Veeam Backup Administrator** for every call, **Veeam Backup Operator** to start, stop and retry jobs, **Veeam Restore Operator** to restore, or **Veeam Backup Viewer** for agents that only read.

**3. Mark it as a service account**

When multi-factor authentication is on for the console, select the account and mark it as a **service account**, so Neo can sign in with its password alone.

Neo can do only what this user may do, whatever the agent's access profile says.

> [!WARNING]
>
> If the account's password changes or it is removed from Users and Roles, Neo loses access to this client's server until you save the new password here.

## 2. Add the connection in Neo

**1. Open Integrations**

In the Neo Dashboard, open [**Integrations** → **Veeam Backup & Replication**](https://dashboard.neoagent.io/integrations?open=veeam_br), under Backup & Recovery.

**2. Save the server and the user**

In **Customer**, choose the client this server belongs to; the client must be on your **Companies** tab, and **Add customer** adds the next one. Then enter the server's REST API address with its port (for example `https://vbr.example.com:9419`, or the proxy's address), the server's **Version** from **Help → About** in the console, the user name and the password. Click **Save settings**. Neo signs in and reads the server's version before saving, so a wrong address, a refused password or a version newer than the server is rejected straight away.

## 3. Turn it on per agent

Open the agent, go to its **Tools & Settings** tab, click **Backup & Recovery**, and expand the **Veeam Backup & Replication** block. Pick one of its **Presets**, or set each area yourself:

| Area | Covers |
| - | - |
| **Jobs & Sessions** | Jobs and their state, sessions and their logs; start, stop, retry, enable and disable a job |
| **Job Settings** | Create, edit, clone and delete jobs; global VM exclusions |
| **Backups & Restore Points** | Backups, protected machines, restore points and replicas |
| **Restore & Failover** | Instant recovery, entire VM, file and Microsoft Entra ID restores, failover and failback |
| **Repositories & Storage** | Repositories, their capacity and free space, and cloud storage |
| **Servers & Proxies** | Managed servers, proxies, mount servers, the inventory and the high availability cluster |
| **Agents & Protection Groups** | Protection groups, Veeam Agent installs, recovery tokens and recovery appliances |
| **Malware Detection & Security** | Malware events and settings, scans, exclusions and the Security & Compliance Analyzer |
| **Credentials & Encryption** | Credentials records, cloud credentials, encryption passwords and KMS servers |
| **Users & Roles** | The server's users, roles and multi-factor authentication settings |
| **Server Settings & License** | Server information, general options, the license, configuration backup and log export |

| Preset | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Reads, and starting, stopping, retrying, enabling and disabling jobs | A restore. Every other area stays read only |
| **IT Admin** | Every read and most writes | A restore or failover, users and roles, and malware detection |
| **Full Automation** | Every read and write | Only the writes that always ask |

The writes that always ask, whatever the preset, are listed under Safety Controls on the [Veeam Backup & Replication API](https://docs.neoagent.io/agents/tools/backup/veeam-br-api.md#safety-controls) page.

## Use it on job tickets

Veeam Backup & Replication emails a job's result when the job ends, and most MSPs open a ticket from each failed or warning email. The subject names the result and the job, for example `[Failed] Daily VMs (3 machines) 1 failed`. An agent that triggers on those tickets finds the job and the session, reads why each machine failed, retries the job, and closes the ticket once a read shows the retry succeeded.

File each ticket under the client's company, so the agent calls that client's backup server.

See [Veeam Backup & Replication API](https://docs.neoagent.io/agents/tools/backup/veeam-br-api.md) for what the agent can read and change.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.