Veeam Backup for Microsoft Office 365 4.0
RESTful API Reference
Related documents

Adding Organizations

This section explains how to add a Microsoft Office 365 or on-premises Microsoft organization to the Veeam Backup for Microsoft Office 365 scope.

Request

POST https://<hostname>:4443/v4/Organizations

Request Headers

The request header must contain an authorization token of the current session.

Request Body

The request body can contain different properties depending on the organization type: Microsoft Office 365, on-premises or Hybrid.

Adding Office365 Organizations

To add a Microsoft Office 365 organization, set the following properties:

Property

Type

Description

Type

string

Specifies the organization type.

  • Microsoft Office 365
  • on-premises
  • Hybrid

Region

string

Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located:

  • Worldwide
  • USgovCommunity
  • Germany
  • China
  • USgovDefence

IsExchangeOnline

bool

If set to True, indicates that this organization contains Microsoft Office 365 Exchange components.

IsSharePointOnline

bool

If set to True, indicates that this organization contains Microsoft Office 365 SharePoint components.

ExchangeOnlineSettings

OnlineSettings

Specifies Microsoft Office 365 Exchange organization connection settings.

SharePointOnlineSettings

OnlineSettings

Specifies Microsoft Office 365 SharePoint organization connection settings.

Id

string

Specifies the ID of the organization added to Veeam Backup for Microsoft Office 365.

Name

string

Specifies the name of the Office 365 organization.

OnlineSettings

Specifies the following settings for connecting to the Microsoft Office 365 organization components:

Property

Type

Description

Account

string

Specifies the user account for the Microsoft Office 365 organization.

Password

string

Specifies the user password for the Microsoft Office 365 organization.

GrantAdminAccess

string

If set to True, indicates that the user will obtain Site Collection Admin rights in order to access site collections and sites.

UseMfa

bool

If set to True, indicates that the Veeam Backup for Office 365 will use modern authentication to connect to the organization.

ApplicationId

string

For modern authentication against the Microsoft Office 365 organization. Specifies an application ID for connecting to the Microsoft Office 365 organization.

ApplicationSecret

string

For modern authentication against the Microsoft Office 365 organization. Specifies an application secret for connecting to the Microsoft Office 365 organization.

ApplicationCertificate

string

For modern authentication against the Microsoft Office 365 organization. Specifies a path to the application certificate for connecting to the Microsoft Office 365 organization.

ApplicationCertificatePassword

string

For modern authentication against the Microsoft Office 365 organization. Specifies an application certificate password for connecting to the Microsoft Office 365 organization.

ApplicationCertificateThumbprint

string

For modern authentication against the Microsoft Office 365 organization. Specifies an application certificate thumbprint for connecting to the Microsoft Office 365 organization.

UseCustomVeeamAADApplication

bool

For native authentication against the Microsoft Office 365 organization.

If set to True, indicates that the Veeam Backup for Microsoft Office 365 will use Veeam AAD Application for a connection to the Microsoft Office 365 organization.

Request Example

{

   "type": "Office365",

   "region": "Worldwide",

   "isExchangeOnline": false,

   "isSharePointOnline": true,

   "sharePointOnlineSettings": {

     "account": "user@organization.onmicrosoft.com",

     "Password": "password",

     "grantAdminAccess": true,

     "useMfa": false,

     "useCustomVeeamAADApplication": true

   }

Adding On-Premises Organizations

To add an on-premises organization, set the following properties:

Property

Type

Description

Type

string

Specifies the organization type.

  • Microsoft Office 365
  • on-premises
  • Hybrid

Name

string

Specifies the name of the on-premises organization.

IsExchange

bool

If set to True, indicates that this organization contains on-premises Microsoft Exchange components.

ExchangeSettings

ExchangeSettings

Specifies on-premises Microsoft Exchange settings.

IsSharePoint

bool

If set to True, indicates that this organization contains on-premises Microsoft SharePoint components.

SharePointSettings

SharePointSettings

Specifies on-premises Microsoft SharePoint settings.

Request Example

{

 "Type": "OnPremises",

 "IsExchange": true,

 "ExchangeSettings":

 {

  "ServerName": "server",

  "Username": "Domain\\Administrator",

  "Password": "password",

  "UseSSL": false,

  "GrantImpersonation": true,

  "ConfigureThrottlingpolicy": true

 },

 "IsSharepoint": true,

 "SharepointSettings":

 {

  "ServerName": "server",

  "ServerPort": 5985,

  "Username": "Domain\\Administrator",

  "Password": "pass",

  "UseSSL": false,

  "GrantAccesstositecollections": true

 }

}

Adding Hybrid Organizations

To add a Hybrid organization to Veeam Backup for Microsoft Office 365, set the following properties:

Property

Type

Description

Type

string

Specifies the organization type.

  • Microsoft Office 365
  • on-premises
  • Hybrid

region

string

Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located:

  • Worldwide
  • USgovCommunity
  • Germany
  • China
  • USgovDefence

isExchangeOnline

bool

If set to True, indicates that this organization contains Microsoft Office 365 Exchange components.

isSharePointOnline

bool

If set to True, indicates that this organization contains Microsoft Office 365 SharePoint components.

exchangeOnlineSettings

OnlineSettings

Specifies Microsoft Office 365 settings for the Hybrid organization.

sharePointOnlineSettings

IsExchange

bool

If set to True, indicates that this organization contains on-premises Microsoft Exchange components.

ExchangeSettings

ExchangeSettings

Specifies on-premises Microsoft Exchange settings.

IsSharePoint

bool

If set to True, indicates that this organization contains on-premises Microsoft SharePoint components.

SharePointSettings

SharePointSettings

Specifies on-premises Microsoft SharePoint settings.

Request Example

{

 "Type": "Hybrid",

 "region": "Worldwide",

 "isExchangeOnline": true,

    "isSharePointOnline": true,

 "exchangeOnlineSettings":

 {

  "account": "administrator@abc.onmicrosoft.com",

      "Password": "XXXXXXX",

      "grantAdminAccess": true,

     "useMfa": false,

     "useCustomVeeamAADApplication": true

 },

 "sharePointOnlineSettings":

 {

  "account": "administrator@abc.onmicrosoft.com",

      "Password": "XXXXXXX",

      "grantAdminAccess": true,

     "useMfa": false,

     "useCustomVeeamAADApplication": true

 },

 "IsExchange": true,

 "ExchangeSettings":

 {

  "ServerName": "split",

  "ServerPort": 5985,

  "Username": "domain\\administrator",

  "Password": "password",

  "UseSSL": false,

  "GrantImpersonation": true,

  "ConfigureThrottlingpolicy": true

 },

 "IsSharepoint": true,

 "SharepointSettings":

 {

  "ServerName": "vodice",

  "ServerPort": 5985,

  "Username": "domain\\administrator",

  "Password": "password",

  "UseSSL": false,

  "GrantAccesstositecollections": true

 }

}

Office365Settings

Specify the following Microsoft Office 365 settings for the Hybrid organization:

Property

Type

Description

Region

string

Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located:

  • Worldwide
  • USgovCommunity
  • Germany
  • China
  • USgovDefence

Username

string

Specifies the username for authenticating with the Office 365 organization. Type the organization username in one of the formats: "username"@domain.com" or "user@domain.onmicrosoft.com".

Password

string

Specifies the user password for authenticating with the Office 365 organization.

GrantImpersonation

bool

If set to True, indicates that backup jobs will be able to process all mailboxes within Office 365 organization.

GrantAccessToSiteCollections

bool

If set to True, indicates that the user will obtain a Site Collection Admin rights in order to access site collections and sites.

UseVeeamAADApplication

bool

If set to True, indicates that this organization will use Veeam AAD Application.

ExchangeSettings

Specify the following on-premises Microsoft Exchange settings for the Hybrid organization:

Property

Type

Description

ServerName

string

Specifies Microsoft Exchange server EWS endpoint URL.

GrantImpersonation

bool

If set to True, indicates that backup jobs will be able to process all mailboxes within Exchange organization.

Username

string

Specifies the username for authenticating with the on-premises Microsoft Exchange organization.

UseSSL

bool

If set to True, indicates that Veeam Backup for Microsoft Office 365 uses a secure connection with Microsoft Exchange organization server.

SkipCAverification

bool

If set to True, indicates that Certificate Authority verification check will not be performed.

SkipCommonNameVerification

bool

If set to True, indicates that Common Name verification check will not be performed.

SkipRevocationCheck

bool

If set to True, indicates that the check of certificate expiration against the certificate revocation list will not be performed.

ConfigureThrottlingPolicy

bool

If set to True, indicates that VeeamArchiverThrottlingPolicy will be configured for connecting with Microsoft Exchange organization server.

VeeamArchiverThrottlingPolicy overrides existing Exchange throttling policies and provides unlimited network bandwidth.

SharePointSettings

Specifies the following on-premises Microsoft SharePoint settings:

Property

Type

Description

ServerName

string

Specifies Microsoft SharePoint server EWS endpoint URL.

ServerPort

int

Specifies a port for connection to the Microsoft SharePoint server. Default server port is 5985.

GrantImpersonation

bool

If set to True, indicates that backup jobs will be able to process all items within SharePoint organization.

GrantAccessToSiteCollections

bool

If set to True, indicates that the user will obtain Site Collection Admin rights in order to access site collections and sites.

Username

string

Specifies the username for authenticating with the on-premises Microsoft SharePoint organization.

UseSSL

bool

If set to True, indicates that Veeam Backup for Microsoft Office 365 uses a secure connection with Microsoft SharePoint organization server.

SkipCAverification

bool

If set to True, indicates that Certificate Authority verification check will not be performed.

SkipCommonNameVerification

bool

If set to True, indicates that Common Name verification check will not be performed.

SkipRevocationCheck

bool

If set to True, indicates that the check of certificate expiration against the certificate revocation list will not be performed.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 201 (Created).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

In the response body, the server returns a representation of organization resources. The resource has the following URL: /Organizations/{id}.

Example

Request:

POST https://abc.tech.local:4443/v4/Organizations

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

   "type": "Office365",

   "region": "Worldwide",

   "isExchangeOnline": false,

   "isSharePointOnline": true,

   "sharePointOnlineSettings": {

     "account": "user@organization.onmicrosoft.com",

     "Password": "password",

     "grantAdminAccess": true,

     "useMfa": false,

     "useCustomVeeamAADApplication": true

}

 

Response:

201 Created

 

Response Body:

{

 "type": "Office365",

 "username": "user@organization.onmicrosoft.com",

 "region": "Worldwide",

 "id": "9b538005-3e78-4263-a84e-cc40630747be",

 "name": "test_organization.onmicrosoft.com",

 "isBackedup": false,

 "_links": {

   "self": {

     "href": "https://abc.tech.local:4443/v4/organizations/9b538005-3e78-4263-a84e-cc40630747be"

   },

   "jobs": {

     "href": "https://abc.tech.local:4443/v4/organizations/9b538005-3e78-4263-a84e-cc40630747be/jobs"

   },

   "groups": {

     "href": "https://abc.tech.local:4443/v4/organizations/9b538005-3e78-4263-a84e-cc40630747be/groups"

   },

   "users": {

     "href": "https://abc.tech.local:4443/v4/organizations/9b538005-3e78-4263-a84e-cc40630747be/users"

   },

   "sites": {

     "href": "https://abc.tech.local:4443/v4/organizations/9b538005-3e78-4263-a84e-cc40630747be/sites"

   }

 },

 "_actions": {}

}

This Document Help Center
User GuideRESTful API ReferencePowerShell ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.