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

(GET) /Organizations

Returns a resource representation of а collection of all organizations added to Veeam Backup for Microsoft Office 365.

Request

To get a list of the organizations added to Veeam Backup for Microsoft Office 365, send  GET HTTPS request to the URL of the /Organizations resource.

HTTPS Request

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

Request Headers

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

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

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

Response Body

In the response body, the server returns a representation of the /Organizations collection resource.

Example

The following request returns an entity representation of all organizations added to Veeam Backup for Microsoft Office 365.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

[

 {

   "type": "Office365",

   "username": "support_north@backup.onmicrosoft.com",

   "region": "Worldwide",

   "id": "b9898108-e785-4f8f-8f0d-b05a38880f05",

   "name": "backup.onmicrosoft.com",

   "isBackedup": false,

   "_links": {

     "self": {

       "href": "https://support.north.local:4443/v2/organizations/b9898108-e785-4f8f-8f0d-b05a38880f05"

     },

     "jobs": {

       "href": "https://support.north.local:4443/v2/organizations/b9898108-e785-4f8f-8f0d-b05a38880f05/jobs"

     },

     "groups": {

       "href": "https://support.north.local:4443/v2/organizations/b9898108-e785-4f8f-8f0d-b05a38880f05/groups"

     },

     "users": {

       "href": "https://support.north.local:4443/v2/organizations/b9898108-e785-4f8f-8f0d-b05a38880f05/users"

     },

     "sites": {

       "href": "https://support.north.local:4443/v2/organizations/b9898108-e785-4f8f-8f0d-b05a38880f05/sites"

     }

   },

   "_actions": {}

 },

 {

   "type": "OnPremises",

   "isSharepoint": true,

   "sharepointSettings": {

     "serverName": "support_north",

     "username": "Server\\Administrator",

     "useSSL": false,

     "serverPort": 5985

   },

   "isExchange": false,

   "id": "ae1a5622-7fb2-49ec-b2b2-393da59fbed2",

   "name": "support_north",

   "isBackedup": true,

   "firstBackuptime": "2017-06-06T15:18:22.6664413Z",

   "lastBackuptime": "2017-06-06T15:44:00.8634945Z",

   "_links": {

     "self": {

       "href": "https://support.north.local:4443/v2/organizations/ae1a5622-7fb2-49ec-b2b2-393da59fbed2"

     },

     "jobs": {

       "href": "https://support.north.local:4443/v2/organizations/ae1a5622-7fb2-49ec-b2b2-393da59fbed2/jobs"

     },

     "users": {

       "href": "https://support.north.local:4443/v2/organizations/ae1a5622-7fb2-49ec-b2b2-393da59fbed2/users"

     },

     "sites": {

       "href": "https://support.north.local:4443/v2/organizations/ae1a5622-7fb2-49ec-b2b2-393da59fbed2/sites"

     }

   },

   "_actions": {}

 },

...]

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference