Home > Use Cases > Retrieving VMs List

Retrieving VMs List

A sample SessionToken will be used throughout this use case.
The sample SessionToken will be: e65aedeb-a0e7-440c-8309-1cc0bcd920db

Base URLs are required depending on the version of VM Backup being used. <base_url> for each version is:

V8.x: http://localhost:35113/api

V9.0.x: http://localhost:36015/api

V9.1.x: http://localhost:36013/api/rest

The API can either retrieve a list of all Virtual Machines, that is, both Virtual Machines configured by VM Backup, as well as the Virtual Machines which reside on the Hypervisor but are not configured by VM Backup. A parameter can be provided to explicitly retrieve Virtual Machines which are configured by VM Backup. For configured VMs, the Response will contain detailed information regarding backups, such as the last backup time, last backup result, last backup size, next backup time, and so on.

 

The following GET request retrieves a list of all configured and un-configured Virtual Machines:

<base_url>/vms/list/e65aedeb-a0e7-440c-8309-1cc0bcd920db

 

The following GET request retrieves a list of configured Virtual Machines by VM Backup:

<base_url>/vms/list/e65aedeb-a0e7-440c-8309-1cc0bcd920db/1

 

Note: A full list of available API commands can be found here