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

format

The format query parameter allows you to define the representation type that you want to retrieve using the query. Veeam Backup Enterprise Manager RESTful API lets you retrieve representations of two types:

  • References (retrieved by default)
  • Entities

To learn more, see Resource Representations.

For example, using the query below, you can get a list of VM restore point entities:

Request:

GET http://localhost:9399/api/query?type=VmRestorePoint&format=entities

 

Response:

200 Success

 

Response Body:

<QueryResult xmlns="http://www.veeam.com/ent/v1.0">
 <Entities>
   <VmRestorePoints>
     <VmRestorePoint Type="VmRestorePoint" Href="http://localhost:9399/api/vmRestorePoints/92357047-d358-4326-8d6d-28bc619b2876?format=Entity" Name="dc01@2015-12-07 11:48:39" UID="urn:veeam:VmRestorePoint:92357047-d358-4326-8d6d-28bc619b2876">
       <Links>
         <Link Rel="Restore" Href="http://localhost:9399/api/vmRestorePoints/92357047-d358-4326-8d6d-28bc619b2876?action=restore" />
         <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/e42211aa-321d-4f91-9c13-2342cf9557eb" Name="172.17.53.47" />
         <Link Rel="Up" Type="RestorePointReference" Href="http://localhost:9399/api/restorePoints/ecda6b9f-1780-452d-ad44-6726855b6547" Name="Dec  7 2015 11:48AM" />
         <Link Rel="Alternate" Type="VmRestorePointReference" Href="http://localhost:9399/api/vmRestorePoints/92357047-d358-4326-8d6d-28bc619b2876" Name="dc01@2015-12-07 11:48:39" />
         <Link Rel="Down" Type="VmRestorePointMountList" Href="http://localhost:9399/api/vmRestorePoints/92357047-d358-4326-8d6d-28bc619b2876/mounts" />
         <Link Rel="Create" Type="VmRestorePointMount" Href="http://localhost:9399/api/vmRestorePoints/92357047-d358-4326-8d6d-28bc619b2876/mounts" />
       </Links>
       <CreationTimeUTC>2015-12-07T11:48:39Z</CreationTimeUTC>
       <Algorithm>Incremental</Algorithm>
       <PointType>Increment</PointType>
       <HierarchyObjRef>urn:VMware:Vm:f75e0690-5f33-4b82-8c52-6828d6c65af6.vm-491</HierarchyObjRef>
     </VmRestorePoint>
     <VmRestorePoint Type="VmRestorePoint" Href="http://localhost:9399/api/vmRestorePoints/1bfb8d41-0d48-4fb7-a348-56612bf0363b?format=Entity" Name="exchange@2015-12-07 12:03:17" UID="urn:veeam:VmRestorePoint:1bfb8d41-0d48-4fb7-a348-56612bf0363b">
       <Links>
         <Link Rel="Restore" Href="http://localhost:9399/api/vmRestorePoints/1bfb8d41-0d48-4fb7-a348-56612bf0363b?action=restore" />
         <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/e42211aa-321d-4f91-9c13-2342cf9557eb" Name="172.17.53.47" />
         <Link Rel="Up" Type="RestorePointReference" Href="http://localhost:9399/api/restorePoints/c61f139b-38d3-402d-88f0-861e1379118d" Name="Dec  7 2015 12:02PM" />
         <Link Rel="Alternate" Type="VmRestorePointReference" Href="http://localhost:9399/api/vmRestorePoints/1bfb8d41-0d48-4fb7-a348-56612bf0363b" Name="exchange@2015-12-07 12:03:17" />
         <Link Rel="Down" Type="VmRestorePointMountList" Href="http://localhost:9399/api/vmRestorePoints/1bfb8d41-0d48-4fb7-a348-56612bf0363b/mounts" />
         <Link Rel="Create" Type="VmRestorePointMount" Href="http://localhost:9399/api/vmRestorePoints/1bfb8d41-0d48-4fb7-a348-56612bf0363b/mounts" />
       </Links>
       <CreationTimeUTC>2015-12-07T12:03:17Z</CreationTimeUTC>
       <Algorithm>Full</Algorithm>
       <PointType>Full</PointType>
       <HierarchyObjRef>urn:VMware:Vm:f75e0690-5f33-4b82-8c52-6828d6c65af6.vm-1618</HierarchyObjRef>
     </VmRestorePoint>
     ...
   </VmRestorePoints>
 </Entities>
 <PagingInfo PageNum="1" PageSize="100" PagesCount="1">
   <Links>
     <Link Rel="First" Href="http://localhost:9399/api/query?type=VmRestorePoint&format=entities&pageSize=100&page=1" />
     <Link Rel="Last" Href="http://localhost:9399/api/query?type=VmRestorePoint&format=entities&pageSize=100&page=1" />
   </Links>
 </PagingInfo>
</QueryResult>

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation