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

(GET) /agents/jobs/{ID}

Returns a resource representation of the Veeam Agent backup job resource having the specified ID. The Veeam Agent backup job is configured in Veeam Backup & Replication.

Request

To get a resource representation of the Veeam Agent backup job, you need to send the GET HTTP request to the URL of the /agents/jobs/{ID} resource:

HTTP Request

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

Request Headers

The request contains the following headers:

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can sent this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

Query Parameters

The following parameters can be used in queries:

Parameter

Type

Description

Can Be Used for Filtering

Can Be Used for Sorting

Uid

URN

ID of the Agent Management job, for example: urn:veeam:Job:da736815-4fea-4c8e-b0e1-5ecdbca1c512.

True

True

Name

String

Name of the Agent Management job, for example: Linux job.

True

True

Description

String

Description of the Agent Management job.

True

True

JobType

String

Defines Agent Management job type. Possible value: AgentBackup.

True

True

Platform

String

Platform for which the job is created. Possible values:

  • AgentForLinux
  • AgentForWindows

True

True

ScheduleConfigured

Boolean

Defines whether scheduling options are specified for the job. Possible values:

  • True
  • False

True

True

ScheduleEnabled

Boolean

Defines whether schedule is enabled for the job. Possible values:

  • True
  • False

True

True

BackupServerUid

URN

ID of the Veeam backup server parent to the Agent Management job resource.

True

True

BackupServerName

String

Name of the Veeam backup server parent to the Agent Management job resource.

True

True

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message. Possible values:

  • application/xml
  • application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /agents/jobs/{ID} resource.

Example

The example below returns an entity resource representation of the Agent Management job having ID 92346ee0-5191-4556-a9c6-ed1a38cdc71b.

Request:

GET http://localhost:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b?format=Entity

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<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="srv02.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 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 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