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

(GET) /jobs/{ID}/includes/{ID}

Returns a representation of a VM or a VM container having the specified ID and processed by the job having the specified ID.

Request

To get a representation of a VM or a VM container processed by the job, you need to send the GET HTTP request to the URL of the /jobs/{ID}/includes/{ID} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/jobs/{ID}/includes/{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.

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

String

ID of the VM or VM container processed by the job, for example: e310aa12-eff2-41f4-97c8-631b677fc17f.

True

True

Name

String

Name of the VM or VM container processed by the job, for example: DC-SRV.

True

True

Order

Int64

Order number for processing the VM or VM container by the job. The processing sequence starts with 0.

True

True

JobUid

URN

ID of the backup or replication job parent to the VM or VM container resource, for example: urn:veeam:Job:da736815-4fea-4c8e-b0e1-5ecdbca1c512.

True

True

JobName

String

Name of the backup or replication job parent to the VM or VM container resource, for example: DC Backup.

True

True

BackupServerUid

URN

ID of the Veeam backup server to which the hierarchy root parent for the VM or VM container resource has been added, for example: urn:veeam:BackupServer:15942270-fb56-4dcc-96e9-5f80e4725a15.

True

True

BackupServerName

String

Name of the Veeam backup server to which the hierarchy root parent for the VM or VM container resource has been added, for example: BACKUPSERVER.

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: application/xml.

Response Body

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

Example

A sample request below returns a resource representation of the VM having ID 83071dc0-44f2-49b6-b431-1cb79ed66639 that is processed by the job having ID da4a15c2-04e7-4135-b876-577249d3d720.

Request:

GET http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes/83071dc0-44f2-49b6-b431-1cb79ed66639

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<ObjectInJob xmlns="http://www.veeam.com/ent/v1.0" Type="ObjectInJob" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes/83071dc0-44f2-49b6-b431-1cb79ed66639">
 <Links>
   <Link Rel="Delete" Type="ObjectInJob" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes/83071dc0-44f2-49b6-b431-1cb79ed66639" Name="oracle" />
   <Link Rel="Up" Type="Job" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720?format=Entity" Name="Oracle Backup" />
 </Links>
 <ObjectInJobId>83071dc0-44f2-49b6-b431-1cb79ed66639</ObjectInJobId>
 <HierarchyObjRef>urn:VMware:Vm:ca2f751f-8f26-4f39-815e-ce493b61fd80.20</HierarchyObjRef>
 <Name>oracle</Name>
 <DisplayName>oracle</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>00000000-0000-0000-0000-000000000000</WindowsCredentialsId>
   <LinuxCredentialsId>00000000-0000-0000-0000-000000000000</LinuxCredentialsId>
 </GuestProcessingOptions>
</ObjectInJob

 

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