Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Teams Channels Restore

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

Get Channels

Returns a collection of channels of a Microsoft Teams team with the specified ID 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
displayName
string

Specifies the display name of the channels whose representation you want to get from the server. The server will return a representation of the channels whose display name contains the value that you specified for this parameter. To filter objects, you can use * and ? wildcard characters.

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}/channels
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Channel
Returns a resource representation of a channel 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.


 
channelId
required
string
Specifies the identification number of the channel. 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}/channels/{channelId}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
  • "_links": {
    }
}
Get Teams Items of Channel
Returns a collection of tabs, posts and files contained in a channel 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.


 
channelId
required
string
Specifies the identification number of the channel. For more information on how to get this parameter, see Get Channels.


 
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/teams/{teamId}/channels/{channelId}/children
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Restore Channel
Restores a channel with the specified ID.


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.


 
channelId
required
string
Specifies the identification number of the channel. For more information on how to get this parameter, see Get Channels.


 
Request Body schema: application/json
required
restoreChangedItems
required
boolean
Defines whether to restore channel items that have been modified in the original location since the time when the backup was created.


 
restoreMissingItems
required
boolean
Defines whether to restore channel items that are missed in the original location.


 
restoreMembers
boolean or null
Defines whether to restore members of the restored channel along with their roles.


 
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}/channels/{channelId}/restore
Request samples 
application/json
{
  • "restoreChangedItems": true,
  • "restoreMissingItems": true,
  • "restoreMembers": true,
  • "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 Channel by Restore Operator
Restores a backed-up Microsoft Teams channel 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.


 
channelId
required
string
Specifies the identification number of the channel. For more information on how to get this parameter, see Get Channels.


 
Request Body schema: application/json
required
restoreChangedItems
required
boolean or null
Defines whether to restore channel items that have been modified in the original location since the time when the backup was created.


 
restoreMissingItems
required
boolean or null
Defines whether to restore channel items that are missed in the original location.


 
restoreMembers
boolean or null
Defines whether to restore members of the restored channel along with their roles.


 
reason
string
Specifies a reason for the restore operation.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/channels/{channelId}/operatorRestore
Request samples 
application/json
{
  • "restoreChangedItems": true,
  • "restoreMissingItems": true,
  • "restoreMembers": true,
  • "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 of a backed-up channel with the specified ID and returns the task ID.


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.


 
channelId
required
string
Specifies the identification number of the channel. For more information on how to get this parameter, see Get Channels.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/channels/{channelId}/startOperatorExportPosts
Request samples 
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 of a backed-up channel 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.


 
channelId
required
string
Specifies the identification number of the channel. For more information on how to get this parameter, see Get Channels.


 
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}/channels/{channelId}/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