Getting Organization

This section explains how to get information about Microsoft Office 365 and on-premises Microsoft organizations.

To use this resource, make sure to obtain a token using the same credentials that were used to add the organization instead of credentials of an administrative account. For more information on how to obtain a token, see Authorization and Security.

Request

GET https://<hostname>:4443/v4/Organization

Request Headers

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

Request Body

None.

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

Property

Type

Description

Id

string

Specifies the ID of the organization added to Veeam Backup for Microsoft Office 365.

Name

string

Specifies the name of the Office 365 organization.

Type

string

Specifies the organization type:

  • Office365
  • OnPremises
  • Hybrid

IsBackedup

boolean

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

firstBackuptime

UTC

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

lastBackuptime

UTC

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

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The following request returns a representation of an organization whose credentials are used to authenticate against the Veeam Backup for Microsoft Office 365 server.

Request:

GET https://abc.tech.local:4443/v4/Organization

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

  "id": "cbc52c37-df7f-4b03-98f3-036e7d4b3127",

  "name": "abc.onmicrosoft.com",

  "type": "Office365",

  "isBackedup": true,

  "firstBackuptime": "2019-05-29T10:29:05.5413083Z",

  "lastBackuptime": "2019-05-29T10:29:05.5413083Z",

  "_actions": {"explore":    {

     "uri": "https://abc.tech.local:4443/v4/organization/action",

     "method": "POST"

  }}

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.