Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

Organizations

The /Organizations resource collection represents Microsoft organizations added to Veeam Backup for Microsoft 365 and allows you to add organizations to the Veeam Backup for Microsoft 365 infrastructure and to manage them.

The /Organization resource collection represents information about Microsoft 365 and on-premises Microsoft organizations that were added as tenants by service providers.

For more information about the authorization process and security settings, see the Veeam Backup for Microsoft 365 REST API Reference, section Authorization for Organizations with Modern Authentication and Legacy Protocols or Basic Authentication.

The /DeviceCode resource collection allows you to obtain a device code to sign in to Microsoft Identity platform and to check whether a device code was used to sign in to Microsoft Identity platform.

Get Organizations

Returns a collection of Microsoft organizations added to the Veeam Backup for Microsoft 365 infrastructure.

SecurityBearer
Request
query Parameters
extendedView
boolean
Default: false

Defines the representation of the organization properties that will be returned to the client. The following values are available:

  • true - controller requests the proxy server and if the proxy server is online, returns all properties of the organization.
  • false - even if the proxy server is offline, the controller returns the organization properties without the isBackedup, firstBackuptime, lastBackuptime properties.
The default value is false.

msid
string <uuid>

Specifies the identification number of the Microsoft 365 organization assigned by Microsoft.

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.

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
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Add Organization
Adds a Microsoft organization to the Veeam Backup for Microsoft 365 infrastructure.  
IMPORTANT 
 Since Microsoft deprecated basic authentication and legacy authentication protocols, adding Microsoft organizations using these authentication methods will be deprecated in future versions of Veeam Backup for Microsoft 365. Use the modern app-only authentication method to add new Microsoft organizations to Veeam Backup for Microsoft 365. 


x-codegen-request-body-name:  organization
SecurityBearer 
Request 
Request Body schema: application/json
required
isTeamsOnline
boolean or null
Defines whether the added organization uses Microsoft Teams and you will be able to back up Microsoft Teams data for this organization.


 
isTeamsChatsOnline
boolean or null
Defines whether the added organization uses team chats and you will be able to back up team chats for this organization.


 
configureApplication
boolean or null
Defines whether you want to let Veeam Backup for Microsoft 365 automatically assign the certificate and required permissions to the specified Microsoft Entra application.


 
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.


Note: To sign in, open Microsoft Identity platform and specify this device code.


 
newApplicationName
write-only
string or null
Specifies the name for the Microsoft Entra application. Veeam Backup for Microsoft 365 automatically creates a new Microsoft Entra application with this name in Microsoft Entra ID.


 
object or null (RESTOffice365ConnectionSettings) 
 
x-veeam-map-to:  Veeam.Archiver.Rest.RESTOffice365ConnectionSettings oneway
object or null (RESTOffice365ConnectionSettings) 
 
x-veeam-map-to:  Veeam.Archiver.Rest.RESTOffice365ConnectionSettings oneway
isExchangeOnline
boolean or null
Defines whether to add an Exchange Online organization.


 
isSharePointOnline
boolean or null
Defines whether to add a SharePoint Online organization.


 
type
string or null (RestOrganizationType) 
Specifies the organization type.


 Enum: "Office365" "OnPremises" "Hybrid"  
region
string or null (RestOrganizationRegion) 
Specifies a Microsoft Entra region.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
name
string
Specifies the name of the Microsoft organization.


 
officeName
string
Specifies the Microsoft 365 Online name.


 
description
string or null
Specifies the Microsoft organization description.


 
isBackedup
boolean or null
Defines whether the organizations was backed up.


 
firstBackuptime
string or null <date-time> 
Specifies the date and time when the first backup was created for the organization.


 
lastBackuptime
string or null <date-time> 
Specifies the date and time when the last backup was created for the organization.


 
msid
string or null <uuid> 
Specifies the identification number of the organization assigned by Microsoft.


 
backedUpOrganizationId
string or null
Specifies the identification number of the backed-up organization in the backup.


 
isSharepoint
boolean or null
Defines whether to add an on-premises SharePoint organization.


 
object (RESTSharepointSettings) 
 
isExchange
boolean or null
Defines whether to add an on-premises Exchange organization.


 
object (RESTExchangeSettings) 
 
Responses 
201
Created


default
Operation failure response.


post/v8/Organizations
Request samples 
application/json
{
  • "isTeamsOnline": true,
  • "isTeamsChatsOnline": true,
  • "configureApplication": true,
  • "userCode": "string",
  • "newApplicationName": "string",
  • "exchangeOnlineSettings": {
    },
  • "sharePointOnlineSettings": {
    },
  • "isExchangeOnline": true,
  • "isSharePointOnline": true,
  • "type": "Office365",
  • "region": "Worldwide",
  • "name": "string",
  • "officeName": "string",
  • "description": "string",
  • "isBackedup": true,
  • "firstBackuptime": "2019-08-24T14:15:22Z",
  • "lastBackuptime": "2019-08-24T14:15:22Z",
  • "msid": "87dd99df-6b92-4088-9037-e179379ebcf2",
  • "backedUpOrganizationId": "string",
  • "isSharepoint": true,
  • "sharepointSettings": {
    },
  • "isExchange": true,
  • "exchangeSettings": {
    }
}
Response samples 
application/json
{
  • "isTeamsOnline": true,
  • "isTeamsChatsOnline": true,
  • "configureApplication": true,
  • "userCode": "string",
  • "exchangeOnlineSettings": {
    },
  • "sharePointOnlineSettings": {
    },
  • "isExchangeOnline": true,
  • "isSharePointOnline": true,
  • "type": "Office365",
  • "region": "Worldwide",
  • "id": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "officeName": "string",
  • "description": "string",
  • "isBackedup": true,
  • "firstBackuptime": "2019-08-24T14:15:22Z",
  • "lastBackuptime": "2019-08-24T14:15:22Z",
  • "msid": "87dd99df-6b92-4088-9037-e179379ebcf2",
  • "backedUpOrganizationId": "string",
  • "_links": {
    },
  • "_actions": {
    },
  • "isSharepoint": true,
  • "sharepointSettings": {
    },
  • "isExchange": true,
  • "exchangeSettings": {
    }
}
Get Organization by Organization ID
Returns a resource representation of 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.


 
query Parameters
extendedView
boolean
 Default:  false
Defines the representation of the organization properties that will be returned to the client. The following values are available: 
     
  • true - controller requests the proxy server and if the proxy server is online, returns all properties of the organization.
    •  
  • false - even if the proxy server is offline, the controller returns the organization properties without the isBackedup, firstBackuptime, lastBackuptime properties.
    •  
 The default value is false.


 
Responses 
200
OK


default
Operation failure response.


get/v8/Organizations/{organizationId}
Request samples 
Response samples 
application/json
{
  • "isTeamsOnline": true,
  • "isTeamsChatsOnline": true,
  • "configureApplication": true,
  • "userCode": "string",
  • "exchangeOnlineSettings": {
    },
  • "sharePointOnlineSettings": {
    },
  • "isExchangeOnline": true,
  • "isSharePointOnline": true,
  • "type": "Office365",
  • "region": "Worldwide",
  • "id": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "officeName": "string",
  • "description": "string",
  • "isBackedup": true,
  • "firstBackuptime": "2019-08-24T14:15:22Z",
  • "lastBackuptime": "2019-08-24T14:15:22Z",
  • "msid": "87dd99df-6b92-4088-9037-e179379ebcf2",
  • "backedUpOrganizationId": "string",
  • "_links": {
    },
  • "_actions": {
    },
  • "isSharepoint": true,
  • "sharepointSettings": {
    },
  • "isExchange": true,
  • "exchangeSettings": {
    }
}
Edit Organization
Modifies settings of an organization with the specified ID.


x-codegen-request-body-name:  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.


 
Request Body schema: application/json
required
isTeamsOnline
boolean or null
Defines whether the added organization uses Microsoft Teams and you will be able to back up Microsoft Teams data for this organization.


 
isTeamsChatsOnline
boolean or null
Defines whether the added organization uses team chats and you will be able to back up team chats for this organization.


 
configureApplication
boolean or null
Defines whether you want to let Veeam Backup for Microsoft 365 automatically assign the certificate and required permissions to the specified Microsoft Entra application.


 
userCode
string
Specifies the authentication code. For more information on how to get a device code, see Get Device Code.


Note: To sign in, open Microsoft Identity platform and specify this device code.


 
newApplicationName
write-only
string or null
Specifies the name for the Microsoft Entra application. Veeam Backup for Microsoft 365 automatically creates a new Microsoft Entra application with this name in Microsoft Entra ID.


 
object or null (RESTOffice365ConnectionSettings) 
 
x-veeam-map-to:  Veeam.Archiver.Rest.RESTOffice365ConnectionSettings oneway
object or null (RESTOffice365ConnectionSettings) 
 
x-veeam-map-to:  Veeam.Archiver.Rest.RESTOffice365ConnectionSettings oneway
isExchangeOnline
boolean or null
Defines whether to add an Exchange Online organization.


 
isSharePointOnline
boolean or null
Defines whether to add a SharePoint Online organization.


 
type
string or null (RestOrganizationType) 
Specifies the organization type.


 Enum: "Office365" "OnPremises" "Hybrid"  
region
string or null (RestOrganizationRegion) 
Specifies a Microsoft Entra region.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
name
string
Specifies the name of the Microsoft organization.


 
officeName
string
Specifies the Microsoft 365 Online name.


 
description
string or null
Specifies the Microsoft organization description.


 
isBackedup
boolean or null
Defines whether the organizations was backed up.


 
firstBackuptime
string or null <date-time> 
Specifies the date and time when the first backup was created for the organization.


 
lastBackuptime
string or null <date-time> 
Specifies the date and time when the last backup was created for the organization.


 
msid
string or null <uuid> 
Specifies the identification number of the organization assigned by Microsoft.


 
backedUpOrganizationId
string or null
Specifies the identification number of the backed-up organization in the backup.


 
isSharepoint
boolean or null
Defines whether to add an on-premises SharePoint organization.


 
object (RESTSharepointSettings) 
 
isExchange
boolean or null
Defines whether to add an on-premises Exchange organization.


 
object (RESTExchangeSettings) 
 
Responses 
204
No Content


default
Operation failure response.


put/v8/Organizations/{organizationId}
Request samples 
application/json
{
  • "isTeamsOnline": true,
  • "isTeamsChatsOnline": true,
  • "configureApplication": true,
  • "userCode": "string",
  • "newApplicationName": "string",
  • "exchangeOnlineSettings": {
    },
  • "sharePointOnlineSettings": {
    },
  • "isExchangeOnline": true,
  • "isSharePointOnline": true,
  • "type": "Office365",
  • "region": "Worldwide",
  • "name": "string",
  • "officeName": "string",
  • "description": "string",
  • "isBackedup": true,
  • "firstBackuptime": "2019-08-24T14:15:22Z",
  • "lastBackuptime": "2019-08-24T14:15:22Z",
  • "msid": "87dd99df-6b92-4088-9037-e179379ebcf2",
  • "backedUpOrganizationId": "string",
  • "isSharepoint": true,
  • "sharepointSettings": {
    },
  • "isExchange": true,
  • "exchangeSettings": {
    }
}
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Remove Organization
Removes 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 
204
No Content


default
Operation failure response.


delete/v8/Organizations/{organizationId}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "errorCode": "ProxyOffline",
  • "stackTrace": "string"
}
Get Organization Repositories
Returns a collection of used backup repositories for 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.


 
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}/usedRepositories
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}
Get Tenant Organization
Returns information about Microsoft 365 and on-premises Microsoft organizations that were added as tenants by service providers.


To use this resource, make sure to obtain a token using the same credentials that were used to add the organization instead of credentials of an administrative account. For more information on how to obtain a token, see the Veeam Backup for Microsoft 365 REST API Reference, section Authorization for Organizations with Modern Authentication and Legacy Protocols or Basic Authentication.


SecurityBearer 
Responses 
200
OK


default
Operation failure response.


get/v8/Organization
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "type": "OnPremises",
  • "isBackedup": true,
  • "firstBackuptime": "2019-08-24T14:15:22Z",
  • "lastBackuptime": "2019-08-24T14:15:22Z",
  • "_actions": {
    }
}
Create Restore Session for Organization by Organization ID
Creates and starts a restore session to explore and restore data from backups for an organization with the specified ID.


x-codegen-request-body-name:  exploreOptions
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
dateTime
string or null <date-time> 
Specifies the date and time.


 
type
string or null
Specifies a type of the restore session to start.


 Enum: "Vex" "Veod" "Vesp" "Vet"  
showDeleted
boolean or null
Defines whether the restore session will show items that have been removed by the user before the specified date.


 
showAllVersions
boolean or null
Defines whether the restore session will show all versions of items that have been modified by the user before the specified date.


 
Responses 
201
Created


default
Operation failure response.


post/v8/Organizations/{organizationId}/explore
Request samples 
application/json
{
  • "dateTime": "2019-08-24T14:15:22Z",
  • "type": "Vex",
  • "showDeleted": true,
  • "showAllVersions": true
}
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "name": "string",
  • "organization": "string",
  • "type": "Vex",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Working",
  • "result": "Success",
  • "initiatedBy": "string",
  • "details": "string",
  • "scopeName": "string",
  • "clientHost": "string",
  • "reason": "string",
  • "eTag": 0,
  • "_links": {
    }
}
Get Device Code
Allows you to obtain a device code to sign in to Microsoft Identity platform.


x-codegen-request-body-name:  representation
SecurityBearer 
Request 
Request Body schema: application/json
required
targetRegion
string or null
Specifies the region of the Microsoft 365 organization that you plan to add.


 Enum: "Worldwide" "Germany" "China" "USDefence" "USGovernment"  
loginGraphAppOrganizationId
string or null <uuid> 
Specifies the identification number of the Microsoft 365 organization in which Microsoft Graph API application you want to log in using the device code. For more information on how to get this parameter, see Get Organizations.


 
Responses 
200
OK


default
Operation failure response.


post/v8/DeviceCode
Request samples 
application/json
{
  • "targetRegion": "Worldwide",
  • "loginGraphAppOrganizationId": "40bf0ed1-1d1c-4dbb-9baa-0f077fa14329"
}
Response samples 
application/json
{
  • "userCode": "string",
  • "verificationUrl": "string",
  • "expiresIn": 0,
  • "message": "string"
}
Check Device Code
Allows you to check whether a device code was used to sign in to Microsoft Identity platform.


x-codegen-request-body-name:  deviceCode
SecurityBearer 
Request 
Request Body schema: application/json
required
userCode
required
string
Specifies the device code that you want to check whether it was used to sign in to Microsoft Identity platform.


 
Responses 
200
OK


default
Operation failure response.


post/v8/DeviceCode/check
Request samples 
application/json
{
  • "userCode": "string"
}
Response samples 
application/json
{
  • "authenticated": true
}

    
    

                                

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