Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Teams Restore

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

Get Teams

Returns a collection of backed-up teams to explore and restore Microsoft Teams data.

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.

query Parameters
displayName
string

Specifies the display name of the teams whose representation you want to get from the server. The server will return a representation of the teams 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
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Team
Returns a resource representation of a backed-up team 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.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RestoreSessions/{restoreSessionId}/organization/teams/{teamId}
Request samples 
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "displayName": "string",
  • "description": "string",
  • "groupEmail": "string",
  • "alias": "string",
  • "privacy": "Public",
  • "settings": {
    },
  • "isArchived": true,
  • "_links": {
    }
}
Restore Teams
Restores backed-up teams.


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.


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


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


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


 
restoreSettings
required
boolean or null
Defines whether to restore settings of the restored team.


 
Array of objects (RESTTeamsTeam) 
Specifies IDs of the teams that you want to restore. For more information on how to get such IDs, see Get Teams.


 
impersonationAccountName
string
Specifies a user name of the account that will be used as a team owner account to restore a team. This may be useful if you restore a previously removed team at the time when the original team owner account does not exist in Microsoft 365.


Note: This property is required if you want to use an application certificate for data restore. Use this property only with the applicationCertificate property. If you omit this property, Veeam Backup for Microsoft 365 will restore a team using an original team owner account from the backup.


 
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/restore
Request samples 
application/json
{
  • "teams": [
    ],
  • "restoreChangedItems": true,
  • "restoreMissingItems": true,
  • "restoreMembers": true,
  • "restoreSettings": true,
  • "impersonationAccountName": "string",
  • "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 Teams by Restore Operator
Restores backed-up teams 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.


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


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


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


 
restoreSettings
required
boolean or null
Defines whether to restore settings of the restored team.


 
impersonationAccountName
required
string
Specifies a user name of the account that will be used as a team owner account to restore a team. This may be useful if you restore a previously removed team at the time when the original team owner account does not exist in Microsoft 365.


Note: This property is required if you want to use an application certificate for data restore. Use this property only with the applicationCertificate property. If you omit this property, Veeam Backup for Microsoft 365 will restore a team using an original team owner account from the backup.


 
Array of objects (RESTTeamsTeam) 
Specifies IDs of the teams that you want to restore. For more information on how to get such IDs, see Get Teams.


 
reason
string
Specifies a reason for the restore operation.


 
Responses 
200
OK


default
Operation failure response.


post/v8/RestoreSessions/{restoreSessionId}/organization/teams/operatorRestore
Request samples 
application/json
{
  • "teams": [
    ],
  • "restoreChangedItems": true,
  • "restoreMissingItems": true,
  • "restoreMembers": true,
  • "restoreSettings": true,
  • "reason": "string",
  • "impersonationAccountName": "string"
}
Response samples 
application/json
{
  • "sessionId": "00000000-0000-0000-0000-000000000000"
}
Restore Team
Restores a backed-up team 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.


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


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


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


 
restoreSettings
required
boolean or null
Defines whether to restore settings of the restored team.


 
Array of objects (RESTTeamsTeam) 
Specifies IDs of the teams that you want to restore. For more information on how to get such IDs, see Get Teams.


 
impersonationAccountName
string
Specifies a user name of the account that will be used as a team owner account to restore a team. This may be useful if you restore a previously removed team at the time when the original team owner account does not exist in Microsoft 365.


Note: This property is required if you want to use an application certificate for data restore. Use this property only with the applicationCertificate property. If you omit this property, Veeam Backup for Microsoft 365 will restore a team using an original team owner account from the backup.


 
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}/restore
Request samples 
application/json
{
  • "teams": [
    ],
  • "restoreChangedItems": true,
  • "restoreMissingItems": true,
  • "restoreMembers": true,
  • "restoreSettings": true,
  • "impersonationAccountName": "string",
  • "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