Adds an Exchange organization to Veeam Backup for Microsoft Office 365.
Request
To add an Exchange 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>:<Port>/v1/Organizations |
Request Headers
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 Exchange organization type: Microsoft Office 365, On-Premises Microsoft Exchange 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 Exchange organization type. For example, "type": "office365". |
Region | string | Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located:
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". |
For example:
{ "type": "office365", "region": "worldwide", "username": "eastsupport.onmicrosoft.com", "password": "Passw0rd", "grantImpersonation": "true" } |
To add an On-Premises Microsoft Exchange organization to Veeam Backup for Microsoft Office 365, set the following properties:
Property | Type | Description |
Type | string | Specifies the Exchange organization type. For example, "type": "onpremises". |
ServerName | string | Specifies Microsoft Exchange server EWS endpoint URL. For example, "serverName": "yourmail.migrationendpoint.com". |
GrantImpersonation | 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": "support\\jsmith". |
Password | string | Specifies the user password for authenticating with the On-Premises Microsoft Exchange organization. For example, "password": "Passw0rd". |
UseSSL | bool | If set to True, indicates that Veeam Backup for Microsoft Office 365 will use 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 | 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". |
Configure | bool | If set to True, configures VeeamArchiverThrottlingPolicy for connecting with Microsoft Exchange organization server. VeeamArchiverThrottlingPolicy substitutes existing Exchange throttling policies and provides unlimited network bandwidth. For example, "configureThrottlingpolicy": "true". |
For example:
{ "type": "onpremises", "serverName": "yourmail.migrationendpoint.com", "username": "support\\jsmith", "password": "Passw0rd", "GrantImpersonation": "true", "useSSL": "true", "skipCAverification": "true", "skipCommonNameVerification": "true", "skipRevocationCheck": "true", "configureThrottlingPolicy": "true" } |
To add a Hybrid organization to Veeam Backup for Microsoft Office 365, set the following properties:
Property | Type | Description |
Type | string | Specifies the Exchange organization type. For example, "type": "hybrid". |
Office365Settings | Specifies Microsoft Office 365 settings for the Hybrid organization. | |
OnPremisesSettings | Specifies On-Premises Microsoft Exchange settings for the Hybrid organization. |
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:
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". |
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". |
GrantImpersonation | 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". |
Password | string | Specifies the user password for authenticating with the On-Premises Microsoft Exchange organization. For example, "password": "Passw0rd". |
UseSSL | bool | If set to True, indicates that Veeam Backup for Microsoft Office 365 will use 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 | 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". |
Configure | bool | If set to True, configures VeeamArchiverThrottlingPolicy for connecting with Microsoft Exchange organization server. VeeamArchiverThrottlingPolicy substitutes existing Exchange throttling policies and provides unlimited network bandwidth. For example, "configureThrottlingpolicy": "true". |
For example:
{ "type": "hybrid", "office365Settings": { "username": "Admin1@eastqa.onmicrosoft.com", "password": "Passw0rd", "region": "worldwide", "grantImpersonation": "true" }, "onPremisesSettings": { "servername": "yourmail.migrationendpointqa.com", "username": "qa\\rstones", "password": "Passw0rd", "useSSL": "true", "skipCAverification": "false", "skipCommonnameverification": "false", "skipRevocationcheck": "false", "grantImpersonation": "true", "configureThrottlingpolicy": "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 Exchange organization resource. The resource has the following URL: /Organizations/{ID}.
Example
The example below shows how to add Office 365 organization to Veeam Backup for Microsoft Office 365.
Request: POST https://support.east.local:4443/v1/Organizations
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "type": "office365", "region": "worldwide", "username": "Admin@eastsupport.onmicrosoft.com", "password": "Passw0rd", "grantImpersonation": "true" }
Response: 201 Created
Response Body: { "type": "Office365", "username": "Admin@eastsupport.onmicrosoft.com", "region": "worldwide", "id": "7b2b1ae1-7bbb-4651-b479-bda7edc7838b", "name": "eastsupport.onmicrosoft.com", "isBackedup": "false", "_links": { "self": { "href": "https://support.east.local:4443/v1/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b" }, "jobs": { "href": "https://support.east.local:4443/v1/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b/Jobs" }, "mailboxes": { "href": "https://support.east.local:4443/v1/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b/mailboxes" } } } |
Related Topics
- Adding Office 365 Organizations
- Adding On-Premises Exchange Organizations
- Adding Organizations of Both Types in Hybrid Deployment
