Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Backup Applications

The /Organizations/{organizationId}/BackupApplications resource collection represents Microsoft Entra applications configured for Microsoft 365 organizations to minimize throttling when backing up Microsoft SharePoint and OneDrive for Business data.

Backup applications can be configured for Microsoft 365 organizations added using modern app-only authentication. For more information, see the Backup Applications section of the Veeam Backup for Microsoft 365 User Guide.

The /Organizations/{organizationId}/DeviceCode resource allows you to obtain a device code to sign in to Microsoft Identity platform.

Get Configured Backup Applications

Returns a collection of backup applications that are added to the specified Microsoft 365 organization.

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.

query Parameters
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/Organizations/{organizationId}/BackupApplications
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Replace Backup Applications
Replaces existing backup applications with new ones for the specified Microsoft 365 organization.


x-codegen-request-body-name:  backupApplications
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
 Array 
object (RESTApplication) 
 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the Base64 string of an SSL certificate that you want to use to access the Microsoft Entra application.


 
Responses 
204
No Content


default
Operation failure response.


put/v8/Organizations/{organizationId}/BackupApplications
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Add Backup Applications
Adds backup applications to the specified Microsoft 365 organization.


x-codegen-request-body-name:  backupApplications
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
 Array 
object (RESTApplication) 
 
applicationCertificatePassword
string <password>  (SecureString) 
Specifies a password.


 
applicationCertificate
string
Specifies the Base64 string of an SSL certificate that you want to use to access the Microsoft Entra application.


 
Responses 
204
No Content


default
Operation failure response.


post/v8/Organizations/{organizationId}/BackupApplications
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Backup Applications
Removes backup applications from the specified Microsoft 365 organization.


x-codegen-request-body-name:  applicationIds
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
 Array 
string <uuid> 
Specifies IDs of the backup applications that you want to remove from the Microsoft 365 organization. For more information on how to get such IDs, see Get Configured Backup Applications. To specify multiple items, use comma.


 
Responses 
204
No Content


default
Operation failure response.


delete/v8/Organizations/{organizationId}/BackupApplications
Request samples 
application/json
[
  • "00000000-0000-0000-0000-000000000000"
]
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Device Code
Allows you to obtain a device code to sign in to Microsoft Identity platform.


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.


post/v8/Organizations/{organizationId}/DeviceCode
Request samples 
Response samples 
application/json
{
  • "userCode": "string",
  • "verificationUrl": "string",
  • "expiresIn": 0,
  • "message": "string"
}

    
    

                                

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