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

/Organizations/{ID}

Represents the organization with a specified ID.

Resource URL

The URL of the reference resource representation:

https://<Backup-Office365>:4443/v2/Organizations/{ID}

Related Resources

Methods

The following methods are supported for the /Organizations/{ID} resource:

Properties

The /Organization/{ID} resource can contain different properties depending on the organization type:

Microsoft Office 365

The /Organization/{ID} resource for the Microsoft Office 365 organization has 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": "7b2b1ae1-7bbb-4651-b479-bda7edc7838b".

Type

string

Specifies the organization type:

  • Office365
  • OnPremises
  • Hybrid

For example, "type": "office365".

Name

string

Specifies the name of the Office 365 organization.

For example, "name": "eastsupport.onmicrosoft.com".

IsBackedup

bool

If set to True, indicates that this organization had already been processed by a backup job.

For example, "isBackedup": "true".

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

Grant
Impersonation

bool

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

For example, "grantImpersonation": "true".

GrantAccessToSiteCollections

bool

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

For example, "grantAccesstositecollections": "true".

UseVeeamAADApplication

bool

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

For example, "useVeeamAADApplication":"true".

First
Backuptime

UTC

Specifies the time when this organization was processed by a backup job for the first time.

For example, "firstBackuptime": "2017-04-05T08:04:55".

Last
Backuptime

UTC

Specifies the time when this organization was processed by a backup job for the last time.

For example, "lastBackuptime": "2017-11-05T17:50:35".

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

On-Premises

The /Organization/{ID} resource for the On-Premises organization has 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".

IsBackedup

bool

If set to True, indicates that this organization had already been processed by a backup job.

For example, "isBackedup": "true".

IsExchange

bool

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

For example, "isExchange": "true".

ExchangeSettings

OnPremisesSettings

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.

First
Backuptime

UTC

Specifies the time when this organization was processed by a backup job for the first time.

For example, "firstBackuptime": "2017-04-05T08:04:55".

Last
Backuptime

UTC

Specifies the time when this organization was processed by a backup job for the last time.

For example, "lastBackuptime": "2017-11-05T17:50:35".

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Hybrid

The /Organization/{ID} resource for the Hybrid organization has 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 the 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

OnPremisesSettings

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.

IsBackedup

bool

If set to True, indicates that this organization has already been processed by a backup job.

For example, "isBackedup": "true".

First
Backuptime

UTC

Specifies the time when this organization was processed by a backup job for the first time.

For example, "firstBackuptime": "2017-04-05T08:04:55".

Last
Backuptime

UTC

Specifies the time when this organization was processed by a backup job for the last time.

For example, "lastBackuptime": "2017-11-05T17:50:35".

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Office365Settings

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

Grant
Impersonation

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 backup jobs backup jobs will be able to process all site collections within Office 365 organization.

For example, "grantAccesstositecollections": "true".

UseVeeamAADApplication

bool

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

For example, "useVeeamAADApplication":"true".

ExchangeSettings

Specifies the following On-Premises Microsoft Exchange settings:

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

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

Resource Representation

The /Organizations/{ID} resource for the Microsoft Office 365 organization has the following representation:

{

   "type": "Office365",

   "id": "7b2b1ae1-7bbb-4651-b479-bda7edc7838b",

   "region": "worldwide",

   "name": "eastsupport.onmicrosoft.com",

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

   "isBackedup": "true",

   "firstBackuptime": "2017-05-14T09:17:45.8491057Z",

   "lastBackuptime": "2017-07-14T09:20:11.3371324Z",

   "_links": {

     "self": {

       "href": "https://support.east.local:4443/v2/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b"

     },

     "jobs": {

       "href": "https://support.east.local:4443/v2/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b/Jobs"

     },

     "mailboxes": {

       "href": "https://support.east.local:4443/v2/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b/mailboxes"

     }

   },

   "_actions": {}

}

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference