Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Protected Data

This set of endpoints represents objects that Veeam Backup for Microsoft 365 protects and allows you to manage them.

Get Protected Users

Returns a collection of protected users.

SecurityBearer
Request
query Parameters
organizationId
string <uuid>

Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations.

backedUpOrganizationId
string

Specifies the identification number of the backed-up Microsoft organization in the backup. For more information on how to get this parameter, see Get Backed-Up Organizations.

repositoryId
string <uuid>

Specifies the identification number of the backup repository. For more information on how to get this parameter, see Get Backup Repositories.

restorePointId
string

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

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/ProtectedUsers
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Protected User
Returns a resource representation of a protected user with the specified ID.


SecurityBearer 
Request 
path Parameters
protectedUserId
required
string
Specifies the identification number of the protected user. For more information on how to get this parameter, see Get Protected Users.


 
Responses 
200
OK


default
Operation failure response.


get/v8/ProtectedUsers/{protectedUserId}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "msid": "string",
  • "displayName": "string",
  • "accountType": "User",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "backedUpOrganizationId": "string",
  • "mailboxes": [
    ],
  • "oneDrives": [
    ],
  • "sites": [
    ],
  • "eTag": 0
}
Get Protected Groups
Returns a collection of protected groups.


SecurityBearer 
Request 
query Parameters
organizationId
string <uuid> 
Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations.


 
backedUpOrganizationId
string
Specifies the identification number of the backed-up Microsoft organization in the backup. For more information on how to get this parameter, see Get Backed-Up Organizations.


 
repositoryId
string <uuid> 
Specifies the identification number of the backup repository. For more information on how to get this parameter, see Get Backup Repositories.


 
restorePointId
string
Specifies the identification number of the restore point. For more information on how to get this parameter, see Get Restore Points.


 
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/ProtectedGroups
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Protected Group
Returns a resource representation of a protected group with the specified ID.


SecurityBearer 
Request 
path Parameters
protectedGroupId
required
string
Specifies the identification number of the protected user. For more information on how to get this parameter, see Get Protected Groups.


 
Responses 
200
OK


default
Operation failure response.


get/v8/ProtectedGroups/{protectedGroupId}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "msid": "string",
  • "displayName": "string",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "backedUpOrganizationId": "string",
  • "mailboxes": [
    ],
  • "sites": [
    ],
  • "eTag": 0
}
Get Protected Sites
Returns a collection of protected SharePoint sites.


SecurityBearer 
Request 
query Parameters
organizationId
string <uuid> 
Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations.


 
backedUpOrganizationId
string
Specifies the identification number of the backed-up Microsoft organization in the backup. For more information on how to get this parameter, see Get Backed-Up Organizations.


 
repositoryId
string <uuid> 
Specifies the identification number of the backup repository. For more information on how to get this parameter, see Get Backup Repositories.


 
restorePointId
string
Specifies the identification number of the restore point. For more information on how to get this parameter, see Get Restore Points.


 
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/ProtectedSites
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Protected Site
Returns a resource representation of a protected SharePoint site with the specified ID.


SecurityBearer 
Request 
path Parameters
protectedSiteId
required
string
Specifies the identification number of the protected user. For more information on how to get this parameter, see Get Protected Sites.


 
Responses 
200
OK


default
Operation failure response.


get/v8/ProtectedSites/{protectedSiteId}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "msid": "string",
  • "displayName": "string",
  • "url": "string",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "backedUpOrganizationId": "string",
  • "eTag": 0
}
Get Protected Teams
Returns a collection of protected teams.


SecurityBearer 
Request 
query Parameters
organizationId
string <uuid> 
Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations.


 
backedUpOrganizationId
string
Specifies the identification number of the backed-up Microsoft organization in the backup. For more information on how to get this parameter, see Get Backed-Up Organizations.


 
repositoryId
string <uuid> 
Specifies the identification number of the backup repository. For more information on how to get this parameter, see Get Backup Repositories.


 
restorePointId
string
Specifies the identification number of the restore point. For more information on how to get this parameter, see Get Restore Points.


 
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/ProtectedTeams
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Protected Team
Returns a resource representation of a protected team with the specified ID.


SecurityBearer 
Request 
path Parameters
protectedTeamId
required
string
Specifies the identification number of the protected user. For more information on how to get this parameter, see Get Protected Teams.


 
Responses 
200
OK


default
Operation failure response.


get/v8/ProtectedTeams/{protectedTeamId}
Request samples 
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "msid": "00000000-0000-0000-0000-000000000000",
  • "displayName": "string",
  • "description": "string",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "backedUpOrganizationId": "string",
  • "eTag": 0
}

    
    

                                

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