This is an archive version of the document. To get the most up-to-date information, see the current version.

/catalog/vms/{vmname}

In this article

Represents a VM having the specified name whose guest OS files have been indexed during backup.

Resource URL

The URL of the reference resource representation:

http://<Enterprise-Manager>:9399/api/catalog/vms/{vmname}

The URL of the entity resource representation:

http://<Enterprise-Manager>:9399/api/catalog/vms/{vmname}?format=Entity

Related Resources

/catalog/vms/{vmname}/vmRestorePoints

Methods

The following methods are supported for the /catalog/vms/{vmname} resource:

(GET) /catalog/vms/{vmname}

Resource Representation

The /catalog/vms/{vmname} resource has a resource representation of the following type.

Entity reference resource representation:

<EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="CatalogVmReference" Href="http://localhost:9399/api/catalog/vms/srv04" Name="srv04" UID="urn:veeam:CatalogVm:srv04">
<Links>
<Link Rel="Alternate" Href="http://localhost:9399/api/catalog/vms/srv04?format=Entity" />
<Link Rel="Down" Type="CatalogVmRestorePointReferenceList" Href="http://localhost:9399/api/catalog/vms/srv04/vmRestorePoints" />
</Links>
</EntityRef>

Entity resource representation:

<CatalogVm xmlns="http://www.veeam.com/ent/v1.0" Type="CatalogVm" Href="http://localhost:9399/api/catalog/vms/srv04?format=Entity" Name="srv04" UID="urn:veeam:CatalogVm:srv04" VmDisplayName="srv04">
<Links>
<Link Rel="Alternate" Type="CatalogVmReference" Href="http://localhost:9399/api/catalog/vms/srv04" Name="srv04" />
<Link Rel="Down" Type="CatalogVmRestorePointReferenceList" Href="http://localhost:9399/api/catalog/vms/srv04/vmRestorePoints" />
</Links>
</CatalogVm>