This is an archive version of the document. To get the most up-to-date information, see the current version.On-Premises Organizations
You can add on-premises Microsoft Exchange and Microsoft SharePoint organizations.
Request
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
The request body must contain the following properties:
Property | Type | Description |
|---|---|---|
type | string | Specifies the type of the organization you add. The following types are available:
|
name | string | Specifies the name of the on-premises organization. |
isExchange | boolean | Defines whether to add an on-premises Exchange organization. |
exchangeSettings | object | Specifies on-premises Microsoft Exchange settings. |
isSharePoint | boolean | Defines whether to add an on-premises SharePoint organization. |
sharePointSettings | object | Specifies on-premises Microsoft SharePoint settings. |
Request Example
Request: POST https://abc.tech.local:4443/v6/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 200 OK.
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 body contains the following properties:
Property | Type | Description |
|---|---|---|
type | string | Specifies the type of the organization. The following types are available:
|
isSharePoint | boolean | Defines whether a SharePoint Online organization is added. |
isExchange | boolean | Defines whether an Exchange Online organization is added. |
exchangeSettings | object | Specifies settings of the Exchange Online organization. |
sharePointSettings | object | Specifies settings of the SharePoint Online organization. |
id | string | Specifies the identification number of the organization in Veeam Backup for Microsoft 365. |
name | string | Specifies the name of the organization. |
isBackedup | boolean | Defines whether 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: 200 OK
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": "/v6/organizations/028aeb89-7445-4d2e-8395-6276a3c4b65a"}, "jobs": {"href": "/v6/organizations/028aeb89-7445-4d2e-8395-6276a3c4b65a/jobs"}, "groups": {"href": "/v6/organizations/028aeb89-7445-4d2e-8395-6276a3c4b65a/groups"}, "users": {"href": "/v6/organizations/028aeb89-7445-4d2e-8395-6276a3c4b65a/users"}, "usedRepositories": {"href": "/v6/organizations/028aeb89-7445-4d2e-8395-6276a3c4b65a/usedRepositories"} }, "_actions": {} } |
