Resource Representation for Key Resources

For key resources, or entities, Veeam Backup Enterprise Manager REST 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 UID, 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:

XML Representation

<EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="JobReference" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d" Name="CRM Backup" UID="urn:veeam:Job:2851cb88-37b6-46ea-b2c8-47b55270169d">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="https://srv12.tech.local:9398/api/backupServers/ffa6d4ef-ea63-4fb3-88a1-84706c2430e1" Name="appsrv01.tech.local" />
   <Link Rel="Alternate" Type="Job" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?format=Entity" Name="CRM Backup" />
   <Link Rel="Down" Type="BackupJobSessionReferenceList" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/backupSessions" />
 </Links>
</EntityRef>

JSON Representation

{

 "Links": [

  {

   "Rel": "Up",

   "Href": "https://srv12.tech.local:9398/api/backupServers/ffa6d4ef-ea63-4fb3-88a1-84706c2430e1",

   "Name": "appsrv01.tech.local",

   "Type": "BackupServerReference"

  },

  {

   "Rel": "Alternate",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?format=Entity",

   "Name": "CRM Backup",

   "Type": "Job"

  },

  {

   "Rel": "Down",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/backupSessions",

   "Type": "BackupJobSessionReferenceList"

  }

 ],

 "UID": "urn:veeam:Job:2851cb88-37b6-46ea-b2c8-47b55270169d",

 "Name": "CRM Backup",

 "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d",

 "Type": "JobReference"

}

Entity Resource Representation

The entity resource representation provides complete information about the resource:

  • Basic information about the resource: its UID, 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  https://localhost:9398/api/jobs/b04c217b-0538-4650-bec4-19deff4ea1ac?format=Entity

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

XML Representation

<Job xmlns="http://www.veeam.com/ent/v1.0" Type="Job" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?format=Entity" Name="CRM Backup" UID="urn:veeam:Job:2851cb88-37b6-46ea-b2c8-47b55270169d">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="https://srv12.tech.local:9398/api/backupServers/ffa6d4ef-ea63-4fb3-88a1-84706c2430e1" Name="appsrv01.tech.local" />
   <Link Rel="Alternate" Type="JobReference" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d" Name="CRM Backup" />
   <Link Rel="Edit" Type="JobReference" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d" Name="CRM Backup" />
   <Link Rel="Clone" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=clone" />
   <Link Rel="ToggleScheduleEnabled" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=toggleScheduleEnabled" />
   <Link Rel="Down" Type="ObjectInJobList" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes" />
   <Link Rel="Down" Type="BackupJobSessionReferenceList" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/backupSessions" />
   <Link Rel="Create" Type="ObjectInJob" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes" />
   <Link Rel="Start" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=start" />
   <Link Rel="Stop" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=stop" />
   <Link Rel="Retry" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=retry" />
 </Links>
 <JobType>Backup</JobType>
 <Platform>VMware</Platform>
 <Description>Backup of CRM system</Description>
 <ScheduleConfigured>true</ScheduleConfigured>
 <ScheduleEnabled>true</ScheduleEnabled>
 <NextRun>2020-02-04T13:00:00Z</NextRun>
 <JobScheduleOptions>
   <Standart>
     <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>14:00:00.0000000+01:00</Time>
       <TimeOffsetUtc>2</TimeOffsetUtc>
     </OptionsDaily>
     <OptionsMonthly Enabled="false">
       <Time>22:00:00.0000000+01:00</Time>
       <TimeOffsetUtc>2</TimeOffsetUtc>
       <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>
       <DayOfMonth>1</DayOfMonth>
     </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">
       <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>
     </OptionsContinuous>
     <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>
   </Standart>
 </JobScheduleOptions>
 <JobInfo>
   <BackupJobInfo>
     <Includes>
       <ObjectInJob Type="ObjectInJob" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes/fd0abfab-e931-45e0-a315-bd236a3d2788">
         <ObjectInJobId>fd0abfab-e931-45e0-a315-bd236a3d2788</ObjectInJobId>
         <HierarchyObjRef>urn:VMware:Vm:3b8ebdcc-41de-4c42-a001-a344f2e75550.vm-62230</HierarchyObjRef>
         <Name>crm01</Name>
         <DisplayName>crm01</DisplayName>
         <GuestProcessingOptions>
           <VssSnapshotOptions>
             <VssSnapshotMode>RequireSuccess</VssSnapshotMode>
             <IsCopyOnly>false</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>OnlyOnSuccessJob</TransactionLogsProcessing>
             <BackupLogsFrequencyMin>15</BackupLogsFrequencyMin>
             <UseDbBackupRetention>true</UseDbBackupRetention>
             <RetainDays>15</RetainDays>
           </SqlBackupOptions>
           <WindowsCredentialsId />
           <LinuxCredentialsId />
         </GuestProcessingOptions>
       </ObjectInJob>
       <ObjectInJob Type="ObjectInJob" Href="https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes/51e37e0e-800a-4639-a2c7-0379330ea1ee">
         <ObjectInJobId>51e37e0e-800a-4639-a2c7-0379330ea1ee</ObjectInJobId>
         <HierarchyObjRef>urn:VMware:Vm:3b8ebdcc-41de-4c42-a001-a344f2e75550.vm-62228</HierarchyObjRef>
         <Name>dbserver01</Name>
         <DisplayName>dbserver01</DisplayName>
         <GuestProcessingOptions>
           <VssSnapshotOptions>
             <VssSnapshotMode>RequireSuccess</VssSnapshotMode>
             <IsCopyOnly>false</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>OnlyOnSuccessJob</TransactionLogsProcessing>
             <BackupLogsFrequencyMin>15</BackupLogsFrequencyMin>
             <UseDbBackupRetention>true</UseDbBackupRetention>
             <RetainDays>15</RetainDays>
           </SqlBackupOptions>
           <WindowsCredentialsId />
           <LinuxCredentialsId />
         </GuestProcessingOptions>
       </ObjectInJob>
     </Includes>
     <GuestProcessingOptions>
       <VssSnapshotOptions>
         <VssSnapshotMode>Disabled</VssSnapshotMode>
         <IsCopyOnly>false</IsCopyOnly>
       </VssSnapshotOptions>
       <WindowsGuestFSIndexingOptions>
         <FileSystemIndexingMode>Disabled</FileSystemIndexingMode>
         <IncludedIndexingFolders />
         <ExcludedIndexingFolders />
       </WindowsGuestFSIndexingOptions>
       <LinuxGuestFSIndexingOptions>
         <FileSystemIndexingMode>Disabled</FileSystemIndexingMode>
         <IncludedIndexingFolders />
         <ExcludedIndexingFolders />
       </LinuxGuestFSIndexingOptions>
       <SqlBackupOptions>
         <TransactionLogsProcessing>OnlyOnSuccessJob</TransactionLogsProcessing>
         <BackupLogsFrequencyMin>15</BackupLogsFrequencyMin>
         <UseDbBackupRetention>true</UseDbBackupRetention>
         <RetainDays>15</RetainDays>
       </SqlBackupOptions>
       <WindowsCredentialsId />
       <LinuxCredentialsId />
     </GuestProcessingOptions>
     <AdvancedStorageOptions>
       <PasswordKeyId />
     </AdvancedStorageOptions>
     <GfsRetentionPolicy Enabled="false">
       <Weekly>
         <Enabled>false</Enabled>
         <RetentionPeriod>1</RetentionPeriod>
         <SelectedDay>Sunday</SelectedDay>
       </Weekly>
       <Monthly>
         <Enabled>false</Enabled>
         <RetentionPeriod>1</RetentionPeriod>
         <SelectedWeek>First</SelectedWeek>
       </Monthly>
       <Yearly>
         <Enabled>false</Enabled>
         <RetentionPeriod>1</RetentionPeriod>
         <SelectedMonth>January</SelectedMonth>
       </Yearly>
     </GfsRetentionPolicy>
     <SimpleRetentionPolicy>
       <RetainCycles>5</RetainCycles>
       <RetainDaysToKeep>7</RetainDaysToKeep>
       <RetainLimitType>Cycles</RetainLimitType>
     </SimpleRetentionPolicy>
   </BackupJobInfo>
 </JobInfo>
</Job>

 

JSON Representation

{

 "JobType": "Backup",

 "Platform": "VMware",

 "Description": "Backup of CRM system",

 "ScheduleConfigured": true,

 "ScheduleEnabled": true,

 "NextRun": "2020-02-04T13:00:00Z",

 "JobScheduleOptions": {

  "Standart": {

   "RetryOptions": {

    "RetryTimes": 3,

    "RetryTimeout": 10,

    "RetrySpecified1": true

   },

   "WaitForBackupCompletion": true,

   "BackupCompetitionWaitingPeriodMin": 180,

   "OptionsDaily": {

    "Kind": "Everyday",

    "Days": [

     "Sunday",

     "Monday",

     "Tuesday",

     "Wednesday",

     "Thursday",

     "Friday",

     "Saturday"

    ],

    "Time": "2019-10-23T14:00:00",

    "TimeOffsetUtc": 2,

    "Enabled": true

   },

   "OptionsMonthly": {

    "Time": "2019-10-23T22:00:00+02:00",

    "TimeOffsetUtc": 2,

    "DayNumberInMonth": "Fourth",

    "DayOfWeek": "Saturday",

    "Months": [

     "January",

     "February",

     "March",

     "April",

     "May",

     "June",

     "July",

     "August",

     "September",

     "October",

     "November",

     "December"

    ],

    "DayOfMonth": 1,

    "Enabled": false

   },

   "OptionsPeriodically": {

    "Kind": "Hours",

    "FullPeriod": 1,

    "Schedule": {

     "Days": [

      {

       "Name": "Sunday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Monday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Tuesday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Wednesday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Thursday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Friday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Saturday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      }

     ]

    },

    "Enabled": false

   },

   "OptionsContinuous": {

    "Schedule": {

     "Days": [

      {

       "Name": "Sunday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Monday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Tuesday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Wednesday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Thursday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Friday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Saturday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      }

     ]

    },

    "Enabled": false

   },

   "OptionsBackupWindow": {

    "TimePeriods": {

     "Days": [

      {

       "Name": "Sunday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Monday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Tuesday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Wednesday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Thursday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Friday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      },

      {

       "Name": "Saturday",

       "Value": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"

      }

     ]

    },

    "Enabled": false

   },

   "OptionsDaisyChaining": {

    "PreviousJobUid": "",

    "Enabled": false

   }

  },

  "ImmediateCopyMode": null,

  "Links": null,

  "Href": ""

 },

 "JobInfo": {

  "BackupJobInfo": {

   "Includes": {

    "ObjectInJobs": [

     {

      "ObjectInJobId": "fd0abfab-e931-45e0-a315-bd236a3d2788",

      "HierarchyObjRef": "urn:VMware:Vm:3b8ebdcc-41de-4c42-a001-a344f2e75550.vm-62230",

      "Name": "crm01",

      "DisplayName": "crm01",

      "GuestProcessingOptions": {

       "AppAwareProcessingMode": null,

       "FileSystemIndexingMode": null,

       "IncludedIndexingFolders": null,

       "ExcludedIndexingFolders": null,

       "CredentialsId": null,

       "VssSnapshotOptions": {

        "VssSnapshotMode": "RequireSuccess",

        "IsCopyOnly": false

       },

       "WindowsGuestFSIndexingOptions": {

        "FileSystemIndexingMode": "ExceptSpecifiedFolders",

        "IncludedIndexingFolders": [],

        "ExcludedIndexingFolders": [

         "%windir%",

         "%ProgramFiles%",

         "%ProgramFiles(x86)%",

         "%ProgramW6432%",

         "%TEMP%"

        ]

       },

       "LinuxGuestFSIndexingOptions": {

        "FileSystemIndexingMode": "ExceptSpecifiedFolders",

        "IncludedIndexingFolders": [],

        "ExcludedIndexingFolders": [

         "/cdrom",

         "/dev",

         "/media",

         "/mnt",

         "/proc",

         "/tmp",

         "/lost+found"

        ]

       },

       "SqlBackupOptions": {

        "TransactionLogsProcessing": "OnlyOnSuccessJob",

        "BackupLogsFrequencyMin": 15,

        "UseDbBackupRetention": true,

        "RetainDays": 15

       },

       "WindowsCredentialsId": "",

       "LinuxCredentialsId": "",

       "FSFileExcludeOptions": null,

       "OracleBackupOptions": null

      },

      "Links": null,

      "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes/fd0abfab-e931-45e0-a315-bd236a3d2788",

      "Type": "ObjectInJob"

     },

     {

      "ObjectInJobId": "51e37e0e-800a-4639-a2c7-0379330ea1ee",

      "HierarchyObjRef": "urn:VMware:Vm:3b8ebdcc-41de-4c42-a001-a344f2e75550.vm-62228",

      "Name": "dbserver01",

      "DisplayName": "dbserver01",

      "GuestProcessingOptions": {

       "AppAwareProcessingMode": null,

       "FileSystemIndexingMode": null,

       "IncludedIndexingFolders": null,

       "ExcludedIndexingFolders": null,

       "CredentialsId": null,

       "VssSnapshotOptions": {

        "VssSnapshotMode": "RequireSuccess",

        "IsCopyOnly": false

       },

       "WindowsGuestFSIndexingOptions": {

        "FileSystemIndexingMode": "ExceptSpecifiedFolders",

        "IncludedIndexingFolders": [],

        "ExcludedIndexingFolders": [

         "%windir%",

         "%ProgramFiles%",

         "%ProgramFiles(x86)%",

         "%ProgramW6432%",

         "%TEMP%"

        ]

       },

       "LinuxGuestFSIndexingOptions": {

        "FileSystemIndexingMode": "ExceptSpecifiedFolders",

        "IncludedIndexingFolders": [],

        "ExcludedIndexingFolders": [

         "/cdrom",

         "/dev",

         "/media",

         "/mnt",

         "/proc",

         "/tmp",

         "/lost+found"

        ]

       },

       "SqlBackupOptions": {

        "TransactionLogsProcessing": "OnlyOnSuccessJob",

        "BackupLogsFrequencyMin": 15,

        "UseDbBackupRetention": true,

        "RetainDays": 15

       },

       "WindowsCredentialsId": "",

       "LinuxCredentialsId": "",

       "FSFileExcludeOptions": null,

       "OracleBackupOptions": null

      },

      "Links": null,

      "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes/51e37e0e-800a-4639-a2c7-0379330ea1ee",

      "Type": "ObjectInJob"

     }

    ]

   },

   "GuestProcessingOptions": {

    "AppAwareProcessingMode": null,

    "FileSystemIndexingMode": null,

    "IncludedIndexingFolders": null,

    "ExcludedIndexingFolders": null,

    "CredentialsId": null,

    "VssSnapshotOptions": {

     "VssSnapshotMode": "Disabled",

     "IsCopyOnly": false

    },

    "WindowsGuestFSIndexingOptions": {

     "FileSystemIndexingMode": "Disabled",

     "IncludedIndexingFolders": [],

     "ExcludedIndexingFolders": []

    },

    "LinuxGuestFSIndexingOptions": {

     "FileSystemIndexingMode": "Disabled",

     "IncludedIndexingFolders": [],

     "ExcludedIndexingFolders": []

    },

    "SqlBackupOptions": {

     "TransactionLogsProcessing": "OnlyOnSuccessJob",

     "BackupLogsFrequencyMin": 15,

     "UseDbBackupRetention": true,

     "RetainDays": 15

    },

    "WindowsCredentialsId": "",

    "LinuxCredentialsId": "",

    "FSFileExcludeOptions": null,

    "OracleBackupOptions": null

   },

   "AdvancedStorageOptions": {

    "PasswordKeyId": ""

   },

   "GfsRetentionPolicy": {

    "Weekly": {

     "Enabled": false,

     "RetentionPeriod": 1,

     "SelectedDay": "Sunday"

    },

    "Monthly": {

     "Enabled": false,

     "RetentionPeriod": 1,

     "SelectedWeek": "First"

    },

    "Yearly": {

     "Enabled": false,

     "RetentionPeriod": 1,

     "SelectedMonth": "January"

    },

    "Enabled": false

   },

   "SimpleRetentionPolicy": {

    "RetainCycles": 5,

    "RetainDaysToKeep": 7,

    "RetainLimitType": "Cycles"

   }

  },

  "FileCopyJobInfo": null,

  "ReplicaJobInfo": null,

  "BackupCopyJobInfo": null,

  "ImmediateBackupCopyJobInfo": null

 },

 "Name": "CRM Backup",

 "UID": "urn:veeam:Job:2851cb88-37b6-46ea-b2c8-47b55270169d",

 "Links": [

  {

   "Rel": "Up",

   "Href": "https://srv12.tech.local:9398/api/backupServers/ffa6d4ef-ea63-4fb3-88a1-84706c2430e1",

   "Name": "appsrv01.tech.local",

   "Type": "BackupServerReference"

  },

  {

   "Rel": "Alternate",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d",

   "Name": "CRM Backup",

   "Type": "JobReference"

  },

  {

   "Rel": "Edit",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d",

   "Name": "CRM Backup",

   "Type": "JobReference"

  },

  {

   "Rel": "Clone",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=clone"

  },

  {

   "Rel": "ToggleScheduleEnabled",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=toggleScheduleEnabled"

  },

  {

   "Rel": "Down",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes",

   "Type": "ObjectInJobList"

  },

  {

   "Rel": "Down",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/backupSessions",

   "Type": "BackupJobSessionReferenceList"

  },

  {

   "Rel": "Create",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d/includes",

   "Type": "ObjectInJob"

  },

  {

   "Rel": "Start",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=start"

  },

  {

   "Rel": "Stop",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=stop"

  },

  {

   "Rel": "Retry",

   "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?action=retry"

  }

 ],

 "Href": "https://srv12.tech.local:9398/api/jobs/2851cb88-37b6-46ea-b2c8-47b55270169d?format=Entity",

 "Type": "Job"

}

Page updated 9/1/2023

Page content applies to build 12.3.0.310