REST API

[ksurujon@bmc.com]

Hello,

From our REST client we would like to start/stop Veeam jobs and monitor their status.
We would like to trigger jobs regardless of the console that the user uses to connect with the backup server(s),
both Veeam backup& Replication Console and Veeam Backup Enterprise Manager.
The question is which Veeam REST API to use out of the 2: VBR REST API, EM REST API.

Please consider following points:
- Does any of the REST API’s supports (or planned to support in near future) backup servers connected to either of the consoles?
- In v12.1 there are only 3 job types supported via VBR (i.e. VMware vSphere backup jobs, VMware vSphere replication jobs, VMware Cloud Director backup jobs). Is support of all job types expected in VBR in near future?

Thank you in advance
Keren

[Mildur]

Hello Keren

The question is which Veeam REST API to use out of the 2: VBR REST API, EM REST API.

VBR REST API. We don't plan to bring new API calls to the EM Rest API. We still support EM Rest API and will fix bugs. But all new API calls will be made available only in VBR REST API.

- Does any of the REST API’s supports (or planned to support in near future) backup servers connected to either of the consoles?

I apologize, I don't understand the question. The Rest API connects to the backup server and retrieves the information you have requested through API calls. It does that already today. Is your question about feature parity? Having all features from the backup console and enterprise manager available in the backup server RestAPI?

- In v12.1 there are only 3 job types supported via VBR (i.e. VMware vSphere backup jobs, VMware vSphere replication jobs, VMware Cloud Director backup jobs). Is support of all job types expected in VBR in near future?

Yes, that's our plan. We try to add support for more type of workloads with every major (and minor) release.
May I ask, which missing job type would be most important for your business to have it in the RestAPI? Windows Agents?

Best,
Fabian

[Marijn]

Hi Fabian,

Thank you for making clear that Veeam will move forward only with VBR REST API, might be good to also mention this on the documentation pages as i wasn't aware of this until i found this thread.
so mention this here: https://helpcenter.veeam.com/docs/backu ... ml?ver=120

Secondly we're very much looking for information from ALL job types but please start with these ASAP:
- agents ( windows / linux )
- File Shares
- Object storage

In our environment we intend to use the API to query our VBR servers on the jobs and objects they are protecting and matching this data with data from other systems to ensure that all data / hosts / vm's / shares / objects are protected.

I was currently using powershell / sql queries on the host to get most of the required data but would prefer to use the API to query the VBR hosts.

[oleg.feoktistov]

Hi Marijn,

might be good to also mention this on the documentation pages as i wasn't aware of this until i found this thread.

Thanks, I'll pass your feedback to our technical writers team.

Coverage for all job types you mentioned is planned for the next major version as they are of high demand. We also have plans to support all the job types in the future, but it will take time.

Best regards,
Oleg

[l.malherbe]

Hello,

I would like to use the Rest API to get info of Jobs of type "Windows Agent Backup"; unforthunatly it's not compliant with the latest API version :

https://helpcenter.veeam.com/docs/backu ... 0#tag/Jobs
In this version, the REST API supports the following job types:
Backup — VMware vSphere backup jobs
vSphereReplica — VMware vSphere replication jobs
CloudDirectorBackup — VMware Cloud Director backup jobs
EntraIDTenantBackup — Microsoft Entra ID tenant backup jobs
EntraIDAuditLogBackup — Microsoft Entra ID audit log backup jobs
VMware vSphere jobs can process inventory objects of the following types: VirtualMachine, vCenterServer, Datacenter, Cluster, Host, ResourcePool, Folder, Template, Tag, Datastore and DatastoreCluster. Objects with tags combination (or Multitag) are not supported.

=> Do you know if it will be possible to get this type of Jobs through teh Rest API in the futur and when?

Thanks !

[david.domask]

Hi Lionel,

I've moved your post to an existing topic on the subject. Please see Oleg's response above, we have plans to continue expanding the functionality of the REST API, so please stay tuned and check the What's New and Release notes on future releases.

Thanks!