Skip to main content
You connect the console once at the MSP level. One API key covers every company the key’s user manages.

​
Before you start

  • Neo works with Veeam Service Provider Console 8.1 or later (REST API v3). It is built on version 9.3; an older console answers the operations it has.
  • Neo reaches the console over the internet. Its REST API (/api/v3/ on the console’s web address, port 1280 by default) must answer on HTTPS with a certificate from a public certificate authority, at a public address. If a firewall or reverse proxy limits who can reach it, allow Neo’s addresses to reach /api/v3/.

​
If the console is only on your internal network

Publish only the REST API, never the whole portal. Put a reverse proxy at your network edge that:
  • answers on a public name over HTTPS, with a certificate from a public certificate authority;
  • forwards only paths under /api/v3/ to the console’s web address, and refuses every other path;
  • accepts connections only from Neo’s addresses;
  • passes the Authorization header through unchanged.
Save the proxy’s public address in Neo.

​
1. Create an API key for Neo

1

Create a user for Neo

In the console, create a user for Neo, such as neo-agent, with the role your agents need: Portal Administrator for agents that retry jobs, resolve alarms and set up companies, Portal Operator to manage without changing the console’s own settings, or Read-only User for agents that only read.
2

Add an API key

Open the user’s identities (Configuration → Users, then the user’s Identities) and add an API key with the REST scope. Copy it: the console shows it once.
Neo can do only what this user may do, whatever the agent’s access profile says.
If the user is disabled or the key’s identity is deleted, Neo loses access until you save a new key here.

​
2. Add the key in Neo

1

Open Integrations

In the Neo Dashboard, open Integrations → Veeam Service Provider Console, under Backup & Recovery.
2

Save the address and the API key

Enter the address you open the console at, with its port (for example https://vspc.example.com:1280), and the API key, then click Save settings. Neo reads the key’s own user before saving, so a wrong address or a refused key 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 Service Provider Console block. Pick one of its Presets, or set each area yourself: The writes that always ask, whatever the preset, are listed under Safety Controls on the Veeam Service Provider Console API page.

​
Use it on alarm tickets

The console sends its alarm emails to the addresses in each alarm’s notification settings, which is how most MSPs open Veeam tickets in their PSA. The titles name the status, the object, the job for a job alarm, the alarm and the company, for example [Warning] SRV-01 - Daily Backup - Job session state () ~|Acme|~. An agent that triggers on those tickets finds the alarm and its job, retries the job, reads the next run, and resolves the alarm once a run succeeds. Map each company on the Organization Mapping tab first, and make sure your PSA files each alarm ticket under the customer’s company: on a ticket, the agent reaches only the company mapped to the ticket’s company. A connection alarm (a management agent or backup server the console cannot reach) needs the Veeam services restarted on that machine. Give the agent your RMM tools too, and it restarts them there and checks the connection comes back. See Veeam Service Provider Console API for what the agent can read and change.