On-Premises Organizations

In this article

    You can add on-premises Microsoft Exchange and Microsoft SharePoint organizations.

    Request

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

    Request Headers

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

    Request Parameters

    None.

    Request Body

    The following table lists available request properties:

    Property

    Type

    Description

    type

    string

    Sets the type of the organization you add that can be one of the following:

    • Office365
    • OnPremises
    • Hybrid

    name

    string

    Sets the name of the on-premises organization.

    isExchange

    boolean

    Defines whether to add an on-premises Exchange organization.

    exchangeSettings

    object

    Sets on-premises Microsoft Exchange settings.

    isSharePoint

    boolean

    Defines whether to add an on-premises SharePoint organization.

    sharePointSettings

    object

    Sets on-premises Microsoft SharePoint settings.

    Request Example

    Request:

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

     

    Request Header:

    Authorization: Bearer <Access-Token>

    Request Body:

    {

     "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

     }

    }

    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

    The response contains the following information:

    Property

    Type

    Description

    type

    string

    Shows the type of the organization that can be one of the following:

    • Office365
    • OnPremises
    • Hybrid

    isSharePoint

    boolean

    Shows if a SharePoint Online organization is added.

    isExchange

    boolean

    Shows if an Exchange Online organization is added.

    exchangeSettings

    object

    Shows settings of the Exchange Online organization.

    sharePointSettings

    object

    Shows settings of the SharePoint Online organization.

    id

    string

    Shows the identification number of the organization in Veeam Backup for Microsoft Office 365.

    name

    string

    Shows the name of the organization.

    isBackedup

    boolean

    Shows if data of the organization has been backed up.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Response Example

    Response:

    201 Created

     

    Response Body:

    {

      "type": "OnPremises",

      "isSharePoint": false,

      "isExchange": true,

      "exchangeSettings":    {

         "serverName": "split",

         "username": "domain\\administrator",

         "useSSL": false

      },

      "id": "028aeb89-7445-4d2e-8395-6276a3c4b65a",

      "name": "abc",

      "isBackedup": false,

      "_links":    {

         "self": {"href": "https://epsilon.tech.local:4443/v5/organizations/028aeb89-7445-4d2e-8395-6276a3c4b65a"},

         "jobs": {"href": "https://epsilon.tech.local:4443/v5/organizations/028aeb89-7445-4d2e-8395-6276a3c4b65a/jobs"},

         "groups": {"href": "https://epsilon.tech.local:4443/v5/organizations/028aeb89-7445-4d2e-8395-6276a3c4b65a/groups"},

         "users": {"href": "https://epsilon.tech.local:4443/v5/organizations/028aeb89-7445-4d2e-8395-6276a3c4b65a/users"},

         "usedRepositories": {"href": "https://epsilon.tech.local:4443/v5/organizations/028aeb89-7445-4d2e-8395-6276a3c4b65a/usedRepositories"}

      },

      "_actions": {}

    }