Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
RESTful API Reference


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:


The URL of the entity resource representation:


Related Resources



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="" Type="CatalogVmReference" Href="http://localhost:9399/api/catalog/vms/srv04" Name="srv04" UID="urn:veeam:CatalogVm:srv04">
   <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" />

Entity resource representation:

<CatalogVm xmlns="" Type="CatalogVm" Href="http://localhost:9399/api/catalog/vms/srv04?format=Entity" Name="srv04" UID="urn:veeam:CatalogVm:srv04" VmDisplayName="srv04">
   <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" />


Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation