Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Backup Repository Maintenance Sessions

The /RepositoryMaintenanceSessions resource collection represents maintenance sessions during which Veeam Backup for Microsoft 365 suspends operations on the affected backup repositories so that service operations can be performed on the underlying storage.

Get Maintenance Sessions

Returns a collection of maintenance sessions.

SecurityBearer
Request
query Parameters
status
string (RESTBackupRepositoryMaintenanceSessionStatus)

Specifies status to filter maintenance sessions. This parameter is optional.

Enum: "Initialized" "Preparing" "Running" "Finishing" "Finished" "Canceling" "Canceled" "Failing" "Failed"
repositoryId
string <uuid>

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

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.

offset
integer <int32>

Excludes from a response page the first N items of a collection resource. The default value is 0.

Responses
200

OK

default

Operation failure response.

get/v8/backupRepositories/maintenanceSessions
Request samples 
Response samples 
application/json
{
  • "offset": "0",
  • "limit": "30",
  • "setId": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
  • "results": [
    ],
  • "_links": {
    }
}
Create Maintenance Session
Creates and starts a maintenance session during which Veeam Backup for Microsoft 365 suspends operations on the specified backup repositories.


SecurityBearer 
Request 
Request Body schema: application/json
required
repositoryIds
required
Array of strings <uuid>   non-empty 
Specifies an array of IDs of the backup repositories that you want to put under maintenance. For more information on how to get such IDs, see Get Backup Repositories.


 
object or null
Specifies the waiting period settings.


 
Responses 
201
Created


default
Operation failure response.


post/v8/backupRepositories/maintenanceSessions
Request samples 
application/json
{
  • "repositoryIds": [
    ],
  • "waitingConfig": {
    }
}
Response samples 
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "Running",
  • "startTime": "2025-01-15T10:30:00Z",
  • "repositoryIds": [
    ],
  • "waitingConfig": {
    }
}
Get Maintenance Session
Returns a resource representation of a maintenance session with the specified ID.


SecurityBearer 
Request 
path Parameters
sessionId
required
string <uuid> 
Specifies the identification number of the maintenance session. For more information on how to get this parameter, see Get Maintenance Sessions.


 
Responses 
200
OK


404
Maintenance session not found.


default
Operation failure response.


get/v8/backupRepositories/maintenanceSessions/{sessionId}
Request samples 
Response samples 
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "Running",
  • "startTime": "2025-01-15T10:30:00Z",
  • "repositoryIds": [
    ],
  • "waitingConfig": {
    }
}
Stop Maintenance Session
Stops a maintenance session with the specified ID and closes the maintenance window.


SecurityBearer 
Request 
path Parameters
sessionId
required
string <uuid> 
Specifies the identification number of the maintenance session. For more information on how to get this parameter, see Get Maintenance Sessions.


 
Responses 
204
No Content


404
Maintenance session not found.


default
Operation failure response.


post/v8/backupRepositories/maintenanceSessions/{sessionId}/stop
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}

    
    

                                

                                    
Document updated 2026-09-14
Page content applies to build 8.6.0.1102