Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Restore Operator Roles

The /RbacRoles resource collection represents restore operator roles added to Veeam Backup for Microsoft 365 and allows yu to manage restore operator roles.

The /Organizations/{organizationId}/RbacRoles resource allows you to add a restore operator role to an organization.

The Veeam Backup for Microsoft 365 administrator adds restore operator roles to assign permissions to users (or groups) who act as restore operators. Restore operators are allowed to explore and restore data from backups created by Veeam Backup for Microsoft 365 for specific organization object types (users, groups, sites, teams, or the entire Microsoft 365 organization).

Get All Restore Operator Roles

Returns a list of restore operator roles added to Veeam Backup for Microsoft 365.

SecurityBearer
Responses
200

OK

default

Operation failure response.

get/v8/RbacRoles
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get Restore Operator Role
Returns a resource representation of a restore operator role with the specified ID.


SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RbacRoles/{roleId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "description": "string",
  • "roleType": "EntireOrganization",
  • "_links": {
    }
}
Edit Restore Operator Role Settings
Modifies settings of a restore operator role with the specified ID.


x-codegen-request-body-name:  restRbacRoleCreateModel
SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
Request Body schema: application/json
required
id
string or null <uuid> 
Specifies the ID of the restore operator role.


 
organizationId
string <uuid> 
Specifies the backed-up organization ID.


 
name
string
Specifies a name of the restore operator role.


 
description
string
Specifies a description of the restore operator role.


 
roleType
string or null
Specifies the restore operator role type. The following types are available: 
     
  • EntireOrganization. Restore operators are allowed to explore and restore backed-up data of all objects within the specified Microsoft 365 organization.
    •  
  • SpecificObjects. Restore operators are allowed to explore and restore backed-up data of the specified objects.
    •  


Note: For the restore operator role of the SpecificObjects type, you must specify a collection of objects to manage. Restore operators will be able to explore and restore backed-up data of these objects.


 Enum: "EntireOrganization" "SpecificObjects"  
Array of objects (RESTRbacOperator) 
Specifies IDs of the restore operators that you want to add to the restore operator role. For more information on how to get such IDs, see Get Restore Operators.


 
Array of objects (RESTRbacItemComposed) 
Specifies IDs of the objects that you want to add to the restore operator role as objects to manage. Restore operators will be able to explore and restore data from backups created by Veeam Backup for Microsoft 365 for these objects. For more information on how to get such IDs, see Get Objects to Manage.


 
Array of objects (RESTRbacItemComposed) 
Specifies IDs of the objects that you want to exclude from the scope of the restore operator role. Restore operators will not be able to explore and restore data from backups created by Veeam Backup for Microsoft 365 for these objects. For more information on how to get such IDs, see Get Excluded Objects.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/RbacRoles/{roleId}
Request samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "description": "string",
  • "roleType": "EntireOrganization",
  • "operators": [
    ],
  • "selectedItems": [
    ],
  • "excludedItems": [
    ]
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Restore Operator Role
Removes a restore operator role with the specified ID.


SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/RbacRoles/{roleId}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Restore Operators
Returns a resource representation of restore operators added to a restore operator role with the specified ID.


SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RbacRoles/{roleId}/operators
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add Restore Operators
Adds restore operators to a restore operator role with the specified ID.


x-codegen-request-body-name:  itemsToAppend
SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
Request Body schema: application/json
required
 Array 
id
required
string
ID of the restore operator.


 
required
object (RESTRbacGroup) 
 
type
required
string (RESTRbacOperatorType) 
Type of the object.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/RbacRoles/{roleId}/operators
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Restore Operators
Removes restore operators from a restore operator role with the specified ID.


SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
query Parameters
ids
required
string
Specifies IDs of the restore operators that you want to remove from the restore operator role. For more information on how to get such IDs, see Get Restore Operators. To specify multiple items, use comma.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/RbacRoles/{roleId}/operators
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Restore Operator
Returns a resource representation of a restore operator with the specified ID.


SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
operatorId
required
string
Specifies the identification number of the restore operator. For more information on how to get this parameter, see Get Restore Operators.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RbacRoles/{roleId}/operators/{operatorId}
Request samples 
Response samples 
application/json
{
  • "type": "Group",
  • "group": {
    },
  • "id": "string",
  • "_links": {
    }
}
Get Objects to Manage
Returns a resource representation of objects added to a restore operator role with the specified ID. Restore operators are allowed to explore and restore data from backups created by Veeam Backup for Microsoft 365 for these objects.


SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RbacRoles/{roleId}/selectedItems
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add Objects to Manage
Adds objects to a restore operator role with the specified ID. Restore operators will be able to explore and restore data from backups created by Veeam Backup for Microsoft 365 for these objects.


x-codegen-request-body-name:  itemsToAppend
SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
Request Body schema: application/json
required
 Array 
type
string (RESTRbacItemType) 
Type of the managed object.


 Enum: "Group" "User" "Site" "Team"  
object (RESTRbacUser) 
 
id
string
ID of the organization user.


 
object (RESTRbacSite) 
 
object (RESTRbacGroup) 
 
object (RESTRbacTeam) 
 
Responses 
204
No Content


default
Operation failure response.


post/v8/RbacRoles/{roleId}/selectedItems
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Objects to Manage
Removes objects added to a restore operator role with the specified ID as objects to manage from this restore operator role.


SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
query Parameters
ids
required
string
Specifies IDs of the objects to manage that you want to remove from the restore operator role. For more information on how to get such IDs, see Get Objects to Manage. To specify multiple items, use comma.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/RbacRoles/{roleId}/selectedItems
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Object to Manage
Returns a resource representation of an object with the specified ID added to a restore operator role with the specified ID. Restore operators are allowed to explore and restore data from backups created by Veeam Backup for Microsoft 365 for this object.


SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
itemId
required
string
Specifies the identification number of the object added to the list of objects to manage. For more information on how to get this parameter, see Get Objects to Manage.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RbacRoles/{roleId}/selectedItems/{itemId}
Request samples 
Response samples 
application/json
{
  • "type": "Group",
  • "user": {
    },
  • "id": "string",
  • "_links": {
    },
  • "site": {
    },
  • "group": {
    },
  • "team": {
    }
}
Get Excluded Objects
Returns a resource representation of objects excluded from the scope of a restore operator role with the specified ID. Restore operators are not allowed to explore and restore data from backups created by Veeam Backup for Microsoft 365 for these objects.


SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RbacRoles/{roleId}/excludedItems
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add Excluded Objects
Excludes objects from the scope of a restore operator role with the specified ID. Restore operators will not be able to explore and restore data from backups created by Veeam Backup for Microsoft 365 for these objects.


x-codegen-request-body-name:  itemsToAppend
SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
Request Body schema: application/json
required
 Array 
type
string (RESTRbacItemType) 
Type of the managed object.


 Enum: "Group" "User" "Site" "Team"  
object (RESTRbacUser) 
 
id
string
ID of the organization user.


 
object (RESTRbacSite) 
 
object (RESTRbacGroup) 
 
object (RESTRbacTeam) 
 
Responses 
204
No Content


default
Operation failure response.


post/v8/RbacRoles/{roleId}/excludedItems
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Excluded Objects
Removes objects excluded from the restore operator role scope from a restore operator role with the specified ID.


SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
query Parameters
ids
required
string
Specifies IDs of the excluded objects that you want to remove from the restore operator role. For more information on how to get such IDs, see Get Excluded Objects. To specify multiple items, use comma.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/RbacRoles/{roleId}/excludedItems
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Excluded Object
Returns a resource representation of an object with the specified ID excluded from the scope of a restore operator role with the specified ID. Restore operators are not allowed to explore and restore data from backups created by Veeam Backup for Microsoft 365 for this object.


SecurityBearer 
Request 
path Parameters
roleId
required
string <uuid> 
Specifies the identification number of the restore operator role. For more information on how to get this parameter, see Get All Restore Operator Roles.


 
itemId
required
string
Specifies the identification number of the object excluded from the scope of the restore operator role. For more information on how to get this parameter, see Get Excluded Objects.


 
Responses 
200
OK


default
Operation failure response.


get/v8/RbacRoles/{roleId}/excludedItems/{itemId}
Request samples 
Response samples 
application/json
{
  • "type": "Group",
  • "user": {
    },
  • "id": "string",
  • "_links": {
    },
  • "site": {
    },
  • "group": {
    },
  • "team": {
    }
}
Get Restore Operator Roles by Organization ID
Returns a list of restore operator roles added to an organization with the specified ID.


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


 
Responses 
200
OK


default
Operation failure response.


get/v8/Organizations/{organizationId}/RbacRoles
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add Restore Operator Role
Adds a restore operator role to an organization with the specified ID.


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


 
Request Body schema: application/json
required
id
string or null <uuid> 
Specifies the ID of the restore operator role.


 
organizationId
string <uuid> 
Specifies the backed-up organization ID.


 
name
string
Specifies a name of the restore operator role.


 
description
string
Specifies a description of the restore operator role.


 
roleType
string or null
Specifies the restore operator role type. The following types are available: 
     
  • EntireOrganization. Restore operators are allowed to explore and restore backed-up data of all objects within the specified Microsoft 365 organization.
    •  
  • SpecificObjects. Restore operators are allowed to explore and restore backed-up data of the specified objects.
    •  


Note: For the restore operator role of the SpecificObjects type, you must specify a collection of objects to manage. Restore operators will be able to explore and restore backed-up data of these objects.


 Enum: "EntireOrganization" "SpecificObjects"  
Array of objects (RESTRbacOperator) 
Specifies IDs of the restore operators that you want to add to the restore operator role. For more information on how to get such IDs, see Get Restore Operators.


 
Array of objects (RESTRbacItemComposed) 
Specifies IDs of the objects that you want to add to the restore operator role as objects to manage. Restore operators will be able to explore and restore data from backups created by Veeam Backup for Microsoft 365 for these objects. For more information on how to get such IDs, see Get Objects to Manage.


 
Array of objects (RESTRbacItemComposed) 
Specifies IDs of the objects that you want to exclude from the scope of the restore operator role. Restore operators will not be able to explore and restore data from backups created by Veeam Backup for Microsoft 365 for these objects. For more information on how to get such IDs, see Get Excluded Objects.


 
Responses 
201
Created


default
Operation failure response.


post/v8/Organizations/{organizationId}/RbacRoles
Request samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "description": "string",
  • "roleType": "EntireOrganization",
  • "operators": [
    ],
  • "selectedItems": [
    ],
  • "excludedItems": [
    ]
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "description": "string",
  • "roleType": "EntireOrganization",
  • "_links": {
    }
}

    
    

                                

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