Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Teams Tabs Restore

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

The /RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/tabs/operatorRestore resource collection allows restore operators to explore and restore tabs of multiple channels.

Get Tabs

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

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


 
tabId
required
string <uuid> 
Specifies the identification number of the channel tab. For more information on how to get this parameter, see Get Tabs.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/channels/{channelId}/tabs/{tabId}
Request samples 
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "displayName": "string",
  • "contentUrl": "string",
  • "type": "string",
  • "channelId": "string",
  • "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
  • "_links": {
    }
}
Restore Tabs
Restores backed-up Microsoft Teams channel tabs.


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
restoreChangedTabs
required
boolean
Defines whether to restore tabs that have been modified in the original location since the time when the backup was created.


 
restoreMissingTabs
required
boolean
Defines whether to restore tabs that are missed in the original location.


 
Array of objects (RestTeamsTab) 
Specifies IDs of the channel tabs that you want to restore. For more information on how to get such IDs, see Get Tabs.


Note: If you omit this property, all backed-up tabs of the specified channel will be restored.


 
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}/tabs/restore
Request samples 
application/json
{
  • "tabs": [
    ],
  • "restoreChangedTabs": true,
  • "restoreMissingTabs": 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 Tabs by Restore Operator
Restores backed-up Microsoft Teams tabs of a channel with the specified ID 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
restoreChangedTabs
required
boolean
Defines whether to restore tabs that have been modified in the original location since the time when the backup was created.


 
restoreMissingTabs
required
boolean
Defines whether to restore tabs that are missed in the original location.


 
Array of objects (RestTeamsTab) 
Specifies IDs of the channel tabs that you want to restore. For more information on how to get such IDs, see Get Tabs.


Note: If you omit this property, all backed-up tabs of the specified channel will be restored.


 
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}/tabs/operatorRestore
Request samples 
application/json
{
  • "tabs": [
    ],
  • "restoreChangedTabs": true,
  • "restoreMissingTabs": true,
  • "reason": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Restore Tabs of Multiple Channels by Restore Operator
Restores backed-up Microsoft Teams tabs of multiple channels 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
restoreChangedTabs
required
boolean
Defines whether to restore tabs that have been modified in the original location since the time when the backup was created.


 
restoreMissingTabs
required
boolean
Defines whether to restore tabs that are missed in the original location.


 
Array of objects (RestTeamsTab) 
Specifies IDs of the channel tabs that you want to restore. For more information on how to get such IDs, see Get Tabs.


Note: If you omit this property, all backed-up tabs of the specified channel will be restored.


 
reason
string
Specifies a reason for the restore operation.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}/tabs/operatorRestore
Request samples 
application/json
{
  • "tabs": [
    ],
  • "restoreChangedTabs": true,
  • "restoreMissingTabs": true,
  • "reason": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Restore Tabs of Multiple Channels
Restores backed-up Microsoft Teams tabs of multiple channels.


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
restoreChangedTabs
required
boolean
Defines whether to restore tabs that have been modified in the original location since the time when the backup was created.


 
restoreMissingTabs
required
boolean
Defines whether to restore tabs that are missed in the original location.


 
Array of objects (RestTeamsTab) 
Specifies IDs of the channel tabs that you want to restore. For more information on how to get such IDs, see Get Tabs.


Note: If you omit this property, all backed-up tabs of the specified channel will be restored.


 
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}/tabs/restore
Request samples 
application/json
{
  • "tabs": [
    ],
  • "restoreChangedTabs": true,
  • "restoreMissingTabs": 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 Tab
Restores a backed-up Microsoft Teams channel tab 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.


 
tabId
required
string <uuid> 
Specifies the identification number of the channel tab. For more information on how to get this parameter, see Get Tabs.


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


 
restoreMissingTabs
required
boolean
Defines whether to restore tabs that are missed in the original location.


 
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}/tabs/{tabId}/restore
Request samples 
application/json
{
  • "restoreChangedTabs": true,
  • "restoreMissingTabs": 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"
}

    
    

                                

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