Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Teams Posts Restore

The /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts resource collection represents Microsoft Teams posts to explore and restore and allows you to manage backed-up Microsoft Teams posts.

Get Posts

Returns a collection of backed-up Microsoft Teams posts 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.

teamId
required
string <uuid>

Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.

query Parameters
channelId
string

Specifies the identification number of the channel whose posts the server will return in the resource representation. For more information on how to get this parameter, see Get Channels.

If you do not specify this parameter, the server will return a representation of posts pertaining to all channels of the backed-up team.

parentId
integer <int64>

Specifies what information the server will return in the resource representation. The following values are available:

  • <parentID> - ID of a parent post. In the response, the server will return a representation of child posts of the specified parent post.
  • -1 - specifies that the server will return a representation of parent posts only.
If you do not specify this parameter, the server will return a representation of all parent and child posts. Thus, the server will require longer time to execute the request.

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/teams/{teamId}/posts
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Post
Returns a resource representation of a backed-up Microsoft Teams post 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.


 
teamId
required
string <uuid> 
Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.


 
postId
required
integer <int64> 
Specifies the identification number of the post. For more information on how to get this parameter, see Get Posts.


 
query Parameters
channelId
string
Specifies the identification number of the channel whose post the server will return in the resource representation. For more information on how to get this parameter, see Get Channels.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/{postId}
Request samples 
Response samples 
application/json
{
  • "postId": 0,
  • "changeKey": "string",
  • "isImportant": true,
  • "author": "string",
  • "subject": "string",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "lastModifiedTime": "2019-08-24T14:15:22Z",
  • "isDeleted": true,
  • "channelId": "string",
  • "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
  • "parentId": 0,
  • "parentChangeKey": "string",
  • "attachments": [
    ],
  • "_links": {
    }
}
Save Posts
Save backed-up Microsoft Teams posts.


When you save posts, the request command saves posts to MSG files and places the files in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the files are 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 files from the temporary folder.


x-codegen-request-body-name:  action
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.


 
teamId
required
string <uuid> 
Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.


 
Request Body schema: application/json
required
channelId
string
Specifies the ID of the channel whose posts you want to save. Veeam Explorer for Microsoft Teams will save all posts of this channel. For more information on how to get this parameter, see Get Team Channels.


Note: You do not need to use this property if you use the posts property to specify what posts to save.


 
Array of objects (RESTTeamsPost) 
Specifies IDs of the posts that you want to save. The posts must reside in the same channel. For more information on how to get such IDs, see Get Posts.


Note: You do not need to use this property if you use the channelId property to specify a channel whose posts to save.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/save
Request samples 
application/json
{
  • "channelId": "string",
  • "posts": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Save Post
Saves a backed-up Microsoft Teams post with the specified ID.


When you save a post, the request command saves the post to a file in the MSG format and places the file in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the file 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.


 
teamId
required
string <uuid> 
Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.


 
postId
required
integer <int64> 
Specifies the identification number of the post. For more information on how to get this parameter, see Get Posts.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/{postId}/save
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send Posts
Sends backed-up Microsoft Teams posts as attachments in an email message. 
NOTE 
 To send items as attachments, you must specify the Veeam Explorer for Microsoft Teams email settings. For more information, see Edit Email Settings. 


x-codegen-request-body-name:  action
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.


 
teamId
required
string <uuid> 
Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.


 
Request Body schema: application/json
required
channelId
string
Specifies the ID of the channel whose posts you want to send. Veeam Explorer for Microsoft Teams will send all posts of this channel. For more information on how to get this parameter, see Get Team Channels.


Note: You do not need to use this property if you use the posts property to specify what posts to send.


 
Array of objects (RESTTeamsPost) 
Specifies IDs of the posts that you want to send. The posts must reside in the same channel. For more information on how to get such IDs, see Get Posts.


Note: You do not need to use this property if you use the channelId property to specify a channel whose posts to send.


 
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/teams/{teamId}/posts/send
Request samples 
application/json
{
  • "channelId": "string",
  • "posts": [
    ],
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "text": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Send Post
Sends a backed-up Microsoft Teams post 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 Teams email settings. For more information, see Edit Email Settings. 


x-codegen-request-body-name:  action
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.


 
teamId
required
string <uuid> 
Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.


 
postId
required
integer <int64> 
Specifies the identification number of the post. For more information on how to get this parameter, see Get Posts.


 
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/teams/{teamId}/posts/{postId}/send
Request samples 
application/json
{
  • "from": "string",
  • "to": "string",
  • "subject": "string",
  • "text": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Export Posts
Exports backed-up Microsoft Teams posts.


When you export posts, the request command exports posts to an HTML file and places this file in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the HTML file is transferred as application/octet-stream media to the client. To download, read, convert to HTML or perform other actions with the octet-stream, use features of programming languages.


x-codegen-request-body-name:  action
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.


 
teamId
required
string <uuid> 
Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.


 
Request Body schema: application/json
required
Array of objects (RESTTeamsPost) 
Specifies IDs of the posts that you want to export. The posts must reside in the same channel. For more information on how to get such IDs, see Get Posts.


Note: You do not need to use this property if you use the channelId property to specify a channel whose posts to export.


 
channelId
string
Specifies the ID of the channel whose posts you want to export. For more information on how to get this parameter, see Get Team Channels.


Note: If you specify this property, you can use the from and to properties to specify a time period for which you want to export posts. You do not need to use this property if you use the posts property to specify what posts to export.


 
from
string or null <date-time> 
Specifies the point in time that defines the start of the period for which you want to export posts.


 
to
string or null <date-time> 
Specifies the point in time that defines the end of the period for which you want to export posts.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/export
Request samples 
application/json
{
  • "posts": [
    ],
  • "channelId": "string",
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z"
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Export Post
Exports a backed-up Microsoft Teams post with the specified ID.\n\nWhen you export a post, the request command exports the post to an HTML file and places this file in a temporary folder on the Veeam Backup for Microsoft 365 server. After that, the HTML file 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.


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.


 
teamId
required
string <uuid> 
Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.


 
postId
required
integer <int64> 
Specifies the identification number of the post. For more information on how to get this parameter, see Get Posts.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/{postId}/export
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Restore Posts
Restores backed-up Microsoft Teams posts.


x-codegen-request-body-name:  action
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.


 
teamId
required
string <uuid> 
Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.


 
Request Body schema: application/json
required
channelId
required
string
Specifies the ID of the channel whose posts you want to restore. Veeam Explorer for Microsoft Teams will restore all posts of this channel. For more information on how to get this parameter, see Get Team Channels.


Note: If you specify this property, you can use the from and to properties to specify a time period for which you want to restore posts.


 
from
string or null <date-time> 
Specifies the point in time that defines the start of the period for which you want to restore posts.


 
to
string or null <date-time> 
Specifies the point in time that defines the end of the period for which you want to restore posts.


 
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.
This property is required if you want to use a device code for data restore.


 
applicationId
string or null <uuid> 
Specifies the ID of the Microsoft Entra application that you want to use for restore.


 
applicationCertificate
string
Specifies the SSL certificate configured for the Microsoft Entra application that you want to use for data restore. You must provide the certificate as a Base64 string.


 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
userName
string
Specifies the user name that you want to use for authenticating to the organization.


 
userPassword
string <password>  (SecureString) 
Specifies a password.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/restore
Request samples 
application/json
{
  • "channelId": "string",
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "userCode": "string",
  • "applicationId": "00000000-0000-0000-0000-000000000000",
  • "applicationCertificate": "string",
  • "applicationCertificatePassword": "pa$$word",
  • "userName": "string",
  • "userPassword": "pa$$word"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Restore Posts by Restore Operator
Restores backed-up Microsoft Teams posts using Restore Portal. For more information about Restore Portal, see the Data Restore Using Restore Portal section of the Veeam Backup for Microsoft 365 User Guide. 
NOTE 
 To restore data using Restore Portal, you must create a restore session for a restore operator. For more information, see Create Restore Session for Restore Operator. 


x-codegen-request-body-name:  action
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.


 
teamId
required
string <uuid> 
Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.


 
Request Body schema: application/json
required
channelId
required
string
Specifies the ID of the channel whose posts you want to restore using Restore Portal. For more information on how to get this parameter, see Get Team Channels.


Note: If you specify this property, you can use the from and to properties to specify a time period for which you want to restore posts. You do not need to use this property if you use the posts property to specify what posts to restore.


 
from
string or null <date-time> 
Specifies the point in time that defines the start of the period for which you want to restore posts.


 
to
string or null <date-time> 
Specifies the point in time that defines the end of the period for which you want to restore posts.


 
Array of objects or null (RESTTeamsPost) 
Specifies IDs of the posts that you want to restore. The posts must reside in the same channel. For more information on how to get such IDs, see Get Posts.


Note: You do not need to use this property if you use the channelId property to specify a channel whose posts to restore.


 
reason
string
Specifies a reason for the restore operation.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/operatorRestore
Request samples 
application/json
{
  • "channelId": "string",
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "posts": [
    ],
  • "reason": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Get Export by Restore Operator Task ID
Creates a task to export posts and returns the task ID.


x-codegen-request-body-name:  exportOptions
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.


 
teamId
required
string <uuid> 
Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.


 
Request Body schema: application/json
required
required
Array of objects (RESTTeamsPost) 
Specifies IDs of the posts that you want to export. The posts must reside in the same channel. For more information on how to get such IDs, see Get Posts.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/operatorStartExportTask
Request samples 
application/json
{
  • "posts": [
    ]
}
Response samples 
application/json
{
  • "exportTaskId": "ae92ec5c-057a-4084-a871-953079ffa39f"
}
Get Exported Posts by Restore Operator
Returns a file in the HTML format which contains exported posts.


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.


 
teamId
required
string <uuid> 
Specifies the identification number of the team. For more information on how to get this parameter, see Get Teams.


 
requestExportId
required
string <uuid> 
Specifies the identification number of the export task. For more information on how to get this parameter, see Get Export Task ID.


 
query Parameters
authCode
required
string
Specifies the authorization code.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/posts/operatorExport/{requestExportId}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}

    
    

                                

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