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

/agents/jobs/{ID}

Represents an Agent Management job having the specified ID.

Resource URL

The URL of the reference resource representation:

http://<Enterprise-Manager>:9399/api/agents/jobs/{ID}

The URL of the entity resource representation:

http://<Enterprise-Manager>:9399/api/agents/jobs/{ID}?format=Entity

Related Resources

Methods

The following methods are supported for the /agents/jobs/{ID} resource:

Resource Representation

The /agents/jobs/{ID} resource has a resource representation of the following types.

Entity reference resource representation:

<EntityRef UID="urn:veeam:AgentBackupJob:92346ee0-5191-4556-a9c6-ed1a38cdc71b" Name="Agent Backup Job 1" Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b" Type="AgentBackupJobReference" xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <Links>
   <Link Href="http://local.host:9399/api/backupServers/35dfeff8-5104-403b-a208-06e2d9a1da0b" Name="at-win10x64.qahv1.veeam.local" Type="BackupServerReference" Rel="Up"/>
   <Link Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b?format=Entity" Name="Agent Backup Job 1" Type="Job" Rel="Alternate"/>
   <Link Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b/backupSessions" Type="BackupJobSessionReferenceList" Rel="Down"/>
 </Links>
</EntityRef>

Entity resource representation:

<AgentBackupJob Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b?format=Entity" Type="AgentBackupJob" Name="Agent Backup Job 1" UID="urn:veeam:AgentBackupJob:92346ee0-5191-4556-a9c6-ed1a38cdc71b" xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <Links>
   <Link Href="http://local.host:9399/api/backupServers/35dfeff8-5104-403b-a208-06e2d9a1da0b" Name="at-win10x64.qahv1.veeam.local" Type="BackupServerReference" Rel="Up"/>
   <Link Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b" Name="Agent Backup Job 1" Type="JobReference" Rel="Alternate"/>
   <Link Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b/includes" Type="ObjectInJobList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b?action=toggleScheduleEnabled" Rel="ToggleScheduleEnabled"/>
   <Link Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b/backupSessions" Type="BackupJobSessionReferenceList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b?action=start" Rel="Start"/>
   <Link Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b?action=stop" Rel="Stop"/>
   <Link Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b?action=retry" Rel="Retry"/>
 </Links>
 <JobType>AgentBackup</JobType>
 <Platform>AgentForLinux</Platform>
 <Description>Created by AT-WIN10X64\Administrator at 1/4/2018 16:43.</Description>
 <ScheduleConfigured>false</ScheduleConfigured>
 <ScheduleEnabled>true</ScheduleEnabled>
 <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>22:00:00.0000000+03:00</Time>
       <TimeOffsetUtc>3</TimeOffsetUtc>
     </OptionsDaily>
     <OptionsMonthly Enabled="false">
       <Time>22:00:00.0000000+03:00</Time>
       <TimeOffsetUtc>3</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>
   <Includes>
     <ObjectInAgentBackupJob Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b/includes/5bdb14ae-0093-4485-be03-b7c8f109a436" Type="ObjectInAgentBackupJob">
       <ObjectInJobId>5bdb14ae-0093-4485-be03-b7c8f109a436</ObjectInJobId>
       <Name>Protection Group Ubuntu</Name>
       <DisplayName>Protection Group Ubuntu</DisplayName>
       <Order>0</Order>
       <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>
     </ObjectInAgentBackupJob>
   </Includes>
   <GuestProcessingOptions>
     <VssSnapshotOptions>
       <VssSnapshotMode>RequireSuccess</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>
 </JobInfo>
</AgentBackupJob>

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

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation