Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
RESTful API Reference

(POST) /Organizations

Adds an organization to Veeam Backup for Microsoft Office 365.

Request

To add an organization to Veeam Backup for Microsoft Office 365, send the POST HTTPS request to the URL of the /Organizations resource.

HTTPS Request

POST https://<Backup-Office365>:4443/v2/Organizations

Request Headers

The request contains the following headers:

Header

Required

Description

Content-Type: application/json

true

Specifies the type of the content for your request.

Authorization: Bearer <Access-Token>

true

The request header must contain the authorization token for the current logon session.

Request Body

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

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

Property

Type

Description

Type

string

Specifies the organization type.

For example, "type": "office365".

Region

string

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

  • Worldwide
  • USgovCommunity
  • Germany
  • China
  • USgovDefence

For example, "region": "worldwide".

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".

For example, "username": "Admin@eastsupport.onmicrosoft.com".

Password

string

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

For example, "password": "Passw0rd".

GrantImpersonation

bool

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

For example, "grantImpersonation": "true".

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.

For example, "grantAccesstositecollections": "true".

UseVeeamAADApplication

bool

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

For example, "useVeeamAADApplication":"true".

For example:

{

  "Username": "userAlpha@organization.onmicrosoft.com",

  "Password": "password",

  "Type": "Office365",

  "Region": "Worldwide",

  "GrantImpersonation": true,

  "GrantAccessToSiteCollections": true

  "UseVeeamAADApplication": true

}

To add an On-Premises organization to Veeam Backup for Microsoft Office 365, set the following properties:

Property

Type

Description

Id

string

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

For example, "id": "9lk44df4-79vb-0486-r239-edg7eyu5467b".

Type

string

Specifies the type of an organization.

For example, "type": "onpremises".

Name

string

Specifies the name of the On-Premises organization.

For example, "name": "yourmail.migrationendpoint.com".

IsExchange

bool

If set to True, indicates that this organization contains On-Premises Microsoft Exchange components.

For example, "isExchange": "true".

ExchangeSettings

ExchangeSettings

Specifies On-Premises Microsoft Exchange settings.

IsSharePoint

bool

If set to True, indicates that this organization contains On-Premises Microsoft SharePoint components.

For example, "isSharePoint": "true".

SharePointSettings

SharePointSettings

Specifies On-Premises Microsoft SharePoint settings.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

For 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

 }

}

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

Property

Type

Description

Id

string

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

For example, "id": "b2d9414d-c417-4a94-be3b-b38a3c2e8a7b".

Type

string

Specifies the type of Exchange organization.

For example, "type": "hybrid".

Name

string

Specifies the name of the Hybrid organization.

For example, "name": "yourmail.migrationendpointqa.com".

Office365Settings

Office365Settings

Specifies Microsoft Office 365 settings for the Hybrid organization.

IsExchange

bool

If set to True, indicates that this organization contains On-Premises Microsoft Exchange components.

For example, "isExchange": "true".

ExchangeSettings

ExchangeSettings

Specifies On-Premises Microsoft Exchange settings.

IsSharePoint

bool

If set to True, indicates that this organization contains On-Premises Microsoft SharePoint components.

For example, "isSharePoint": "true".

SharePointSettings

SharePointSettings

Specifies On-Premises Microsoft SharePoint settings.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

For example:

{

 "Type": "Hybrid",

 "Office365Settings":

 {

  "Username": "userAlpha@organization.onmicrosoft.com",

  "Password": "password",

  "Region": "Worldwide",

  "GrantImpersonation": true,

  "GrantAccessToSiteCollections": true

 },

 "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

 }

}

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

For example, "region": "worldwide".

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".

For example, "username": "Admin1@eastqa.onmicrosoft.com".

Password

string

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

For example, "password": "Passw0rd".

GrantImpersonation

bool

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

For example, "grantImpersonation": "true".

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.

For example, "grantAccesstositecollections": "true".

UseVeeamAADApplication

bool

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

For example, "useVeeamAADApplication":"true".

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.

For example, "serverName": "yourmail.migrationendpointqa.com".

Grant
Impersonation

bool

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

For example, "grantImpersonation": "true".

Username

string

Specifies the username for authenticating with the On-Premises Microsoft Exchange organization.

For example, "username": "qa\\rstones".

UseSSL

bool

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

For example, "useSSL": "true".

SkipCAverification

bool

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

For example, "skipCAverification": "true".

SkipCommon
NameVerification

bool

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

For example, "skipCommonnameverification": "true".

SkipRevocationCheck

bool

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

For example, "skipRevocationcheck": "true".

ConfigureThrottlingPolicy

bool

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

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

For example, "configureThrottlingpolicy": "true".

SharePointSettings

Specifies the following On-Premises Microsoft SharePoint settings:

Property

Type

Description

ServerName

string

Specifies Microsoft SharePoint server EWS endpoint URL.

For example, "serverName": "yourmail.migrationendpointqa.com".

ServerPort

int

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

For example, "serverPort": "5985".

Grant
Impersonation

bool

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

For example, "grantImpersonation": "true".

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.

For example, "grantAccesstositecollections": "true".

Username

string

Specifies the username for authenticating with the On-Premises Microsoft SharePoint organization.

For example, "username": "qa\\rstones".

UseSSL

bool

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

For example, "useSSL": "true".

SkipCAverification

bool

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

For example, "skipCAverification": "true".

SkipCommon
NameVerification

bool

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

For example, "skipCommonnameverification": "true".

SkipRevocationCheck

bool

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

For example, "skipRevocationcheck": "true".

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns 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 request body message: application/json; charset=utf-8

Response Body

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

Example

Request:

POST https://support.east.local:4443/v2/Organizations

 

Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>

 

Request Body:

 

{

  "Username": "userAlpha@organization.onmicrosoft.com",

  "Password": "password",

  "Type": "Office365",

  "Region": "Worldwide",

  "GrantImpersonation": true,

  "GrantAccessToSiteCollections": true

}

 

Response:

201 Created

 

Response Body:

{

 "type": "Office365",

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

 "region": "Worldwide",

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

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

 "isBackedup": false,

 "_links": {

   "self": {

     "href": "https://support.east.local:4443/v2/organizations/9b538005-3e78-4263-a84e-cc40630747be"

   },

   "jobs": {

     "href": "https://support.east.local:4443/v2/organizations/9b538005-3e78-4263-a84e-cc40630747be/jobs"

   },

   "groups": {

     "href": "https://support.east.local:4443/v2/organizations/9b538005-3e78-4263-a84e-cc40630747be/groups"

   },

   "users": {

     "href": "https://support.east.local:4443/v2/organizations/9b538005-3e78-4263-a84e-cc40630747be/users"

   },

   "sites": {

     "href": "https://support.east.local:4443/v2/organizations/9b538005-3e78-4263-a84e-cc40630747be/sites"

   }

 },

 "_actions": {}

}

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference