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

Resource Representation for Key Resources

For key resources, or entities, Veeam Backup Enterprise Manager RESTful API provides two types of resource representations:

  • Entity reference resource representation
  • Entity resource representation

Entity Reference Resource Representation

The entity reference resource representation provides short information about the resource that is uniform for all entity resources. This type of representation typically contains the following data:

  • Basic resource information: its ID, name, URL and type
  • Information about resources that are related to the current resource

For example, a reference representation for a job resource looks similar to the following:

<EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="JobReference" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac" Name="SQL Replication" UID="urn:veeam:Job:b04c217b-0538-4650-bec4-19deff4ea1ac">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
   <Link Rel="Alternate" Type="Job" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac?format=Entity" Name="SQL Replication" />
   <Link Rel="Down" Type="ReplicaJobSessionReferenceList" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac/replicaSessions" />
 </Links>
</EntityRef>

Entity Resource Representation

The entity resource representation provides complete information about the resource:

  • Basic information about the resource: its ID, name, URL and type
  • Information about the related resources
  • Links to actions that can be performed with the resource and information about the resource settings
  • Other information related to the resource such as object settings and so on.

To get an entity of the resource representation, the client should send the GET HTTP request to the URL of the resource entity:

GET  http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac?format=Entity

In response the server returns an entity representation providing complete information about the resource:

<Job xmlns="http://www.veeam.com/ent/v1.0" Type="Job" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac?format=Entity" Name="SQL Replication" UID="urn:veeam:Job:b04c217b-0538-4650-bec4-19deff4ea1ac">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
   <Link Rel="Alternate" Type="JobReference" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac" Name="SQL Replication" />
   <Link Rel="Down" Type="ReplicaJobSessionReferenceList" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac/replicaSessions" />
   <Link Rel="Down" Type="ObjectInJobList" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac/includes" />
   <Link Rel="Edit" Type="JobReference" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac" Name="SQL Replication" />
   <Link Rel="Create" Type="ObjectInJob" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac/includes" />
   <Link Rel="Start" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac?action=start" />
   <Link Rel="Stop" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac?action=stop" />
   <Link Rel="Retry" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac?action=retry" />
   <Link Rel="Clone" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac?action=clone" />
   <Link Rel="ToggleScheduleEnabled" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac?action=toggleScheduleEnabled" />
 </Links>
 <JobType>Replica</JobType>
 <Platform>VMware</Platform>
 <Description>Created by SRV02\Administrator at 10/7/2014 6:02 AM.</Description>
 <ScheduleConfigured>false</ScheduleConfigured>
 <ScheduleEnabled>true</ScheduleEnabled>
 <JobScheduleOptions>
   <RetryOptions>
     <RetryTimes>3</RetryTimes>
     <RetryTimeout>10</RetryTimeout>
     <RetrySpecified>true</RetrySpecified>
   </RetryOptions>
   <WaitForBackupCompletion>true</WaitForBackupCompletion>
   <BackupCompetitionWaitingPeriodMin>180</BackupCompetitionWaitingPeriodMin>
   <OptionsDaily Enabled="true">
     <Kind>Everyday</Kind>
     <Days>Sunday</Days>
     <Days>Monday</Days>
     <Days>Tuesday</Days>
     <Days>Wednesday</Days>
     <Days>Thursday</Days>
     <Days>Friday</Days>
     <Days>Saturday</Days>
     <Time>22:00:00.0000000-07:00</Time>
   </OptionsDaily>
   <OptionsMonthly Enabled="false">
     <Time>22:00:00.0000000-07:00</Time>
     <DayNumberInMonth>Fourth</DayNumberInMonth>
     <DayOfWeek>Saturday</DayOfWeek>
     <Months>January</Months>
     <Months>February</Months>
     <Months>March</Months>
     <Months>April</Months>
     <Months>May</Months>
     <Months>June</Months>
     <Months>July</Months>
     <Months>August</Months>
     <Months>September</Months>
     <Months>October</Months>
     <Months>November</Months>
     <Months>December</Months>
   </OptionsMonthly>
   <OptionsPeriodically Enabled="false">
     <Kind>Hours</Kind>
     <FullPeriod>1</FullPeriod>
     <Schedule>
       <Day Name="Sunday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Monday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Tuesday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Wednesday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Thursday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Friday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Saturday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
     </Schedule>
   </OptionsPeriodically>
   <OptionsContinuous Enabled="false" />
   <OptionsBackupWindow Enabled="false">
     <TimePeriods>
       <Day Name="Sunday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Monday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Tuesday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Wednesday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Thursday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Friday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
       <Day Name="Saturday">1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1</Day>
     </TimePeriods>
   </OptionsBackupWindow>
   <OptionsDaisyChaining Enabled="false">
     <PreviousJobUid />
   </OptionsDaisyChaining>
 </JobScheduleOptions>
 <JobInfo>
   <ReplicaJobInfo>
     <Includes>
       <ObjectInJob Type="ObjectInJob" Href="http://localhost:9399/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac/includes/d8f628b7-6fe4-498b-bfca-01a167b2124c">
         <ObjectInJobId>d8f628b7-6fe4-498b-bfca-01a167b2124c</ObjectInJobId>
         <HierarchyObjRef>urn:VMware:Vm:ca2f751f-8f26-4f39-815e-ce493b61fd80.11</HierarchyObjRef>
         <Name>sql02</Name>
         <DisplayName>sql02</DisplayName>
         <Order>0</Order>
         <GuestProcessingOptions>
           <VssSnapshotOptions>
             <VssSnapshotMode>RequireSuccess</VssSnapshotMode>
             <IsCopyOnly>true</IsCopyOnly>
           </VssSnapshotOptions>
           <WindowsGuestFSIndexingOptions>
             <FileSystemIndexingMode>ExceptSpecifiedFolders</FileSystemIndexingMode>
             <IncludedIndexingFolders />
             <ExcludedIndexingFolders>
               <Path>%windir%</Path>
               <Path>%ProgramFiles%</Path>
               <Path>%ProgramFiles(x86)%</Path>
               <Path>%ProgramW6432%</Path>
               <Path>%TEMP%</Path>
             </ExcludedIndexingFolders>
           </WindowsGuestFSIndexingOptions>
           <LinuxGuestFSIndexingOptions>
             <FileSystemIndexingMode>ExceptSpecifiedFolders</FileSystemIndexingMode>
             <IncludedIndexingFolders />
             <ExcludedIndexingFolders>
               <Path>/cdrom</Path>
               <Path>/dev</Path>
               <Path>/media</Path>
               <Path>/mnt</Path>
               <Path>/proc</Path>
               <Path>/tmp</Path>
               <Path>/lost+found</Path>
             </ExcludedIndexingFolders>
           </LinuxGuestFSIndexingOptions>
           <SqlBackupOptions>
             <TransactionLogsProcessing>Never</TransactionLogsProcessing>
             <BackupLogsFrequencyMin>15</BackupLogsFrequencyMin>
             <UseDbBackupRetention>true</UseDbBackupRetention>
             <RetainDays>15</RetainDays>
           </SqlBackupOptions>
           <WindowsCredentialsId>00000000-0000-0000-0000-000000000000</WindowsCredentialsId>
           <LinuxCredentialsId>00000000-0000-0000-0000-000000000000</LinuxCredentialsId>
         </GuestProcessingOptions>
       </ObjectInJob>
     </Includes>
     <GuestProcessingOptions>
       <VssSnapshotOptions>
         <VssSnapshotMode>Disabled</VssSnapshotMode>
         <IsCopyOnly>true</IsCopyOnly>
       </VssSnapshotOptions>
       <WindowsGuestFSIndexingOptions>
         <FileSystemIndexingMode>Disabled</FileSystemIndexingMode>
         <IncludedIndexingFolders />
         <ExcludedIndexingFolders />
       </WindowsGuestFSIndexingOptions>
       <LinuxGuestFSIndexingOptions>
         <FileSystemIndexingMode>Disabled</FileSystemIndexingMode>
         <IncludedIndexingFolders />
         <ExcludedIndexingFolders />
       </LinuxGuestFSIndexingOptions>
       <SqlBackupOptions>
         <TransactionLogsProcessing>Never</TransactionLogsProcessing>
         <BackupLogsFrequencyMin>15</BackupLogsFrequencyMin>
         <UseDbBackupRetention>true</UseDbBackupRetention>
         <RetainDays>15</RetainDays>
       </SqlBackupOptions>
       <WindowsCredentialsId>00000000-0000-0000-0000-000000000000</WindowsCredentialsId>
       <LinuxCredentialsId>00000000-0000-0000-0000-000000000000</LinuxCredentialsId>
     </GuestProcessingOptions>
   </ReplicaJobInfo>
 </JobInfo>
</Job>

 

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 Endpoint Backup Documentation

Veeam Management Pack Documentation