Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

SharePoint Attachments Restore

The /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/items/{itemId}/Attachments resource collection represents SharePoint item attachments to explore and restore and allows you to manage a backed-up SharePoint item attachments.

Get SharePoint Attachments

Returns a collection of a SharePoint item attachments to explore and restore.

SecurityBearer
Request
path Parameters
restoreSessionId
required
string <uuid>

Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.

siteId
required
string

Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.

itemId
required
string

Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.

query Parameters
offset
integer <int32>

Excludes from a response page the first N items of a collection resource. The default value is 0.

limit
integer <int32>

Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.

Responses
200

OK

default

Operation failure response.

get/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}/Attachments
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get SharePoint Attachment
Returns a resource representation of a backed-up SharePoint item attachment with the specified ID.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


 
attachmentId
required
string
Specifies the identification item of the attachment. For more information on how to get this parameter, see Get SharePoint Attachments.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}/Attachments/{attachmentId}
Request samples 
Response samples 
application/json
{
  • "sizeBytes": 0,
  • "id": "string",
  • "name": "string",
  • "url": "string",
  • "siteId": "string",
  • "itemId": "string",
  • "_links": {
    }
}
Save SharePoint Attachments
Saves a collection of backed-up SharePoint item attachments.


SharePoint item attachments are always saved in a ZIP archive. When you save item attachments, the request command archives the item attachments and places the ZIP archive in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the archive is transferred as application/octet-stream media to the client. To download, read or perform other actions with the octet-stream, use features of programming languages.


If downloading of the octet-stream was interrupted for some reason, you can send the request again and download the file from the temporary folder.


x-codegen-request-body-name:  options
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


 
Request Body schema: application/json
required
Array of objects (RESTSharePointAttachment) 
Specifies IDs of the SharePoint item attachments that you want to save. For more information on how to get such IDs, see Get SharePoint Attachments.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}/Attachments/save
Request samples 
application/json
{
  • "attachments": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Save SharePoint Attachment
Saves a backed-up SharePoint item attachment with the specified ID.


SharePoint item attachments are always saved in a ZIP archive. When you save a SharePoint item attachment, the request command archives the attachment and places the ZIP archive in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the archive is transferred as application/octet-stream media to the client. To download, read or perform other actions with the octet-stream, use features of programming languages.


If downloading of the octet-stream was interrupted for some reason, you can send the request again and download the file from the temporary folder.


SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


 
attachmentId
required
string
Specifies the identification item of the attachment. For more information on how to get this parameter, see Get SharePoint Attachments.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}/Attachments/{attachmentId}/save
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send SharePoint Attachments
Sends a collection of backed-up SharePoint item attachments as attachments in an email message. 
NOTE 
 To send items as attachments, you must specify the Veeam Explorer for Microsoft SharePoint email settings. For more information, see Edit Email Settings. 


x-codegen-request-body-name:  sendAsMsgOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


 
Request Body schema: application/json
required
Array of objects (RESTSharePointAttachment) 
Specifies IDs of the SharePoint item attachments that you want to send. For more information on how to get such IDs, see Get SharePoint Attachments.


 
from
string
Specifies the email address from which the attachments will be sent.


 
to
string
Specifies the email address to which the attachments will be sent.


 
subject
string
Specifies the subject of the email message used for sending the attachments.


 
text
string
Specifies the body of the email message used for sending the attachments.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}/Attachments/send
Request samples 
application/json
{
  • "attachments": [
    ],
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "text": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send SharePoint Attachment
Sends a backed-up SharePoint item attachment with the specified ID as an attachment in an email message. 
NOTE 
 To send items as attachments, you must specify the Veeam Explorer for Microsoft SharePoint email settings. For more information, see Edit Email Settings. 


x-codegen-request-body-name:  sendAsMsgOptions
SecurityBearer 
Request 
path Parameters
restoreSessionId
required
string <uuid> 
Specifies the identification number of the restore session. For more information on how to get this parameter, see Get Restore Sessions.


 
siteId
required
string
Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Get SharePoint Sites.


 
itemId
required
string
Specifies the identification number of the SharePoint item. For more information on how to get this parameter, see Get SharePoint Items.


 
attachmentId
required
string
Specifies the identification item of the attachment. For more information on how to get this parameter, see Get SharePoint Attachments.


 
Request Body schema: application/json
required
from
string
Specifies the email address from which the attachments will be sent.


 
to
string
Specifies the email address to which the attachments will be sent.


 
subject
string
Specifies the subject of the email message used for sending the attachments.


 
text
string
Specifies the body of the email message used for sending the attachments.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Items/{itemId}/Attachments/{attachmentId}/send
Request samples 
application/json
{
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "text": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}

    
    

                                

                                    
Document updated 12/18/2025
Page content applies to build 8.3.0.2201