REST API knowledge exchange
Post Reply
evgenich
Novice
Posts: 9
Liked: 1 time
Joined: Aug 03, 2023 6:39 am
Full Name: Evgenii Pereverzev
Contact:

VEM API questions

Post by evgenich »

Hi,
Is there are any way to get object type from BackupSession like file share, VM, application with API?
Also is Swagger ui available for VEM?

Thank you
oleg.feoktistov
Veeam Software
Posts: 2015
Liked: 671 times
Joined: Sep 25, 2019 10:32 am
Full Name: Oleg Feoktistov
Contact:

Re: VEM API questions

Post by oleg.feoktistov »

Hi Evgenii,

Is there are any way to get object type from BackupSession like file share, VM, application with API?
Not directly, but you can try to pull this info from BackupTaskSessions. The info in VmUid property might be relevant.
For instance, for VMware vm backups you should get something like this:

Code: Select all

<VmUid>urn:VMware:Vm:d8301ee1-e822-4f1f-b491-1160df6169b2.vm-12970</VmUid>
And for agent backups you should get this (directory refers to agent computers):

Code: Select all

<VmUid>urn:CustomPlatform:Directory:c3a7ebd2-b9d7-4e2a-a7c0-719e9b1b9075.e9493942-83ef-c97c-b517-a1455c5b7ca3</VmUid>
As for file shares, there is a dedicated endpoint, so all the sessions you query there are for file share types.
Also is Swagger ui available for VEM?
No, there isn't an official one, VEM REST is built on the older framework. The closest product API that offers Swagger UI is VBR REST.

Hope that helps,
Oleg
evgenich
Novice
Posts: 9
Liked: 1 time
Joined: Aug 03, 2023 6:39 am
Full Name: Evgenii Pereverzev
Contact:

Re: VEM API questions

Post by evgenich »

Hi Oleg,
Thank you for answer. Cant find deep information abot all objects and their types in Backup Session
For Infrastructure overview what options we also have?
Veeam One? Any reason to use Management Pack?
oleg.feoktistov
Veeam Software
Posts: 2015
Liked: 671 times
Joined: Sep 25, 2019 10:32 am
Full Name: Oleg Feoktistov
Contact:

Re: VEM API questions

Post by oleg.feoktistov »

Hi,

VEM REST API is quite outdated in this regard. The closest API that could report comprehensively on object types in VBR would be Powershell. Further on, I would advise to have a look at VBR REST API. Even though it doesn't all the features now, we do enhance it with every product iteration and add new supported types. For now it doesn't include task sessions, but we are planning to add them in one of our next product versions.

Management Pack has VEShell API (powershell module), but it is all about managing the MP agent itself and doesn't include reports on backed up objects and sessions. As for Veeam ONE, I'm not finding any API requests on backup sessions with the reports on object types, but I think it's better to summon Veeam ONE wizard @jorgedlcruz. He will know for sure.

Best regards,
Oleg
jorgedlcruz
Veeam Software
Posts: 1516
Liked: 660 times
Joined: Jul 17, 2015 6:54 pm
Full Name: Jorge de la Cruz
Contact:

Re: VEM API questions

Post by jorgedlcruz »

Hello,
In VONE we do it a bit differently, having a Job Session per type, like: There is a very detailed map that can help with you visualising what endpoints you can query, for both VBR, and VONE: That will save you a lot of time.

Let us know.
Jorge de la Cruz
Senior Product Manager | Veeam ONE @ Veeam Software

@jorgedlcruz
https://www.jorgedelacruz.es / https://jorgedelacruz.uk
vExpert 2014-2024 / InfluxAce / Grafana Champion
Post Reply

Who is online

Users browsing this forum: No registered users and 3 guests