Veeam Backup & Replication 10
Veeam RESTful API Reference
Related documents

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

Returns a representation of a file or folder having the specified ID and processed by the file share backup job having the specified ID.

Request

To get a representation of a file or folder processed by the file share backup job, you need to send the GET HTTP request to the URL of the /nas/jobs/{ID}/includes/{ID} resource.

HTTP Request

GET https://<Enterprise-Manager>:9398/api/nas/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.

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

String

ID of the file or folder processed by the job, for example: 6fefb504-856d-4c31-b767-76af5567c407.

True

True

Name

String

Name of the file or folder processed by the job, for example: \\srv12\share\archive.

True

True

JobUid

URN

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

True

True

JobName

String

Name of the file share backup job parent to the file or folder resource, for example: Shared Files Backup.

True

True

FileServerUid

URN

ID of the file share parent to the file or folder resource, for example: urn:veeam:FileServer:517be4c8-9c43-4e7c-9f59-4e368d3a8f3c.

True

True

FileServerName

String

Name of the file share parent to the file or folder resource, for example: \\srv12\share.

True

True

BackupServerUid

URN

ID of the Veeam backup server on which the file share parent to the file or folder resource is added, for example: urn:veeam:BackupServer:15942270-fb56-4dcc-96e9-5f80e4725a15.

True

True

BackupServerName

String

Name of the Veeam backup server on which the file share parent to the file or folder resource is added, for example: srv01.

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 /nas/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 https://localhost:9398/api/nas/jobs/da4a15c2-04e7-4135-b876-577249d3d720/includes/83071dc0-44f2-49b6-b431-1cb79ed66639

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<NASObject xmlns="http://www.veeam.com/ent/v1.0" Type="NasObject" Href="https://srv12.tech.local:9398/api/nas/jobs/93dfbb3e-f420-45cf-addc-4ee9297113f2/includes/6fefb504-856d-4c31-b767-76af5567c407">
 <Links>
   <Link Rel="Up" Type="Job" Href="https://srv12.tech.local:9398/api/nas/jobs/93dfbb3e-f420-45cf-addc-4ee9297113f2?format=Entity" Name="Shared Files Backup" />
   <Link Rel="Related" Type="FileServer" Href="https://srv12.tech.local:9398/api/nas/fileServers/517be4c8-9c43-4e7c-9f59-4e368d3a8f3c?format=Entity" Name="\\srv12\share" />
 </Links>
 <HierarchyObjRef>urn:NasBackup:BackupServer:5735d1af-3aad-49ac-ac77-eab708ac1a37</HierarchyObjRef>
 <ObjectInJobId>6fefb504-856d-4c31-b767-76af5567c407</ObjectInJobId>
 <FileOrFolder>\\srv12\share</FileOrFolder>
 <FileServerUid>urn:veeam:FileServer:517be4c8-9c43-4e7c-9f59-4e368d3a8f3c</FileServerUid>
 <InclusionMask>
   <Extension>*.*</Extension>
 </InclusionMask>
 <ExclusionMask>
   <Extension>\\srv12\share\.snapshot</Extension>
   <Extension>\\srv12\share\~snapshot</Extension>
 </ExclusionMask>
</NASObject>

 

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VVeeam Backup Enterprise Manager GuideVeeam Agent Management GuideVeeam Cloud Connect GuideVeeam Explorers User GuideVeeam Plug-ins for Enterprise Applications GuideVeeam PowerShell ReferenceVeeam Explorers PowerShell ReferenceVeeam RESTful API ReferenceRequired Permissions for VMware vSphereQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam Backup for AWS DocumentationVeeam Availability for Nutanix AHV DocumentationVeeam Backup for Microsoft Office 365 DocumentationVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.