Veeam Backup for Microsoft Office 365 4.0
RESTful API Reference
Related documents

Getting Backup Repositories

This section explains how to get a resource representation of a collection of repositories in Veeam Backup for Microsoft Office 365.

Request

GET https://<hostname>:4443/v4/BackupRepositories[?proxyId=<proxyId>]

Request Headers

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

Request Parameters

The following optional parameters can be posted as URL.

Parameter

Type

Description

proxyId

string

An identification number of the backup proxy server. In the response, the server will return backup repositories filtered by the specified proxy server.

Request Body

None.

Request Example

Request:

https://abc.tech.local:4443/v4/BackupRepositories?proxyId=1a087d00-12b2-4902-9b19-22faf05dc14a

 

Request Header:

Authorization: Bearer <Access-Token>

 

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

ObjectStorageId

int

An identification number of object storage.

ObjectStorageCachePath

string

A path to a repository directory on a backup proxy server.

ObjectStorageEncryptionEnabled

boolean

Specifies if the encryption is enabled.

EncryptionKeyId

string

Specifies the encryption key identification number.

isOutOfSync

boolean

Specifies if a backup proxy server needs to be synchronized with object storage to get the same cache state.

capacityBytes

int

The size of a backup repository in Bytes.

freeSpaceBytes

int

Show the available space on a backup repository in Bytes.

id

int

An identification number of a backup repository.

name

string

A backup repository name.

description

string

A backup repository description.

path

string

A path to the directory where backups are stored.

retentionType

string

Specifies the type of the retention policy:

  • ItemLevel
  • SnapshotBased

retentionPeriodType

string

Specifies the retention period type:

  • Daily
  • Monthly
  • Yearly

dailyRetentionPeriod

int

Specifies the retention period in days. This property is valid if retentionPeriodType is set to Daily.

retentionFrequencyType

string

Specifies the retention period in months. This property is valid if retentionPeriodType is set to Monthly.

dailyTime

UTC

For daily clean-up schedule. Specifies the time of the day when clean-up must be performed.

dailyType

string

For daily clean-up schedule. Specifies the days when clean-up must be performed:

proxyId

string

A backup proxy server identification number.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The following request returns a list of backup repositories.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

[

     {

     "isOutOfSync": false,

     "capacityBytes": 135996108800,

     "freeSpaceBytes": 107011002368,

     "id": "e8c58d58-5aaf-4048-83fe-3d3359330409",

     "name": "Default Backup Repository",

     "description": "Created by Veeam Backup for Microsoft Office 365",

     "path": "C:\\VeeamRepository",

     "retentionType": "ItemLevel",

     "retentionPeriodType": "Yearly",

     "yearlyRetentionPeriod": "Years3",

     "retentionFrequencyType": "Daily",

     "dailyTime": "18:00:00",

     "dailyType": "Everyday",

     "proxyId": "1a087d00-12b2-4902-9b19-22faf05dc14a",

     "_links":       {

        "self": {"href": "https://abc.tech.local:4443/v4/backuprepositories/e8c58d58-5aaf-4048-83fe-3d3359330409"},

        "proxy": {"href": "https://abc.tech.local:4443/v4/proxies/1a087d00-12b2-4902-9b19-22faf05dc14a"}

     }

  },

     {

     "objectStorageId": "e78ca0fd-096d-408b-bc81-a4a1f92ae475",

     "objectStorageCachePath": "C:\\Cache",

     "objectStorageEncryptionEnabled": true,

     "encryptionKeyId": "428fbab8-264a-4452-888f-9bb97775307b",

     "isOutOfSync": false,

     "capacityBytes": 135996108800,

     "freeSpaceBytes": 107011002368,

     "id": "baa6aa1e-3086-4a18-836e-ba5c2e9ff7db",

     "name": "Amazon",

     "description": "Created by ABC\\Administrator at 1:09 AM",

     "path": "",

     "retentionType": "ItemLevel",

     "retentionPeriodType": "Yearly",

     "yearlyRetentionPeriod": "Years3",

     "retentionFrequencyType": "Daily",

     "dailyTime": "00:00:00",

     "dailyType": "Everyday",

     "proxyId": "1a087d00-12b2-4902-9b19-22faf05dc14a",

     "_links":       {

        "self": {"href": "https://abc.tech.local:4443/v4/backuprepositories/baa6aa1e-3086-4a18-836e-ba5c2e9ff7db"},

        "proxy": {"href": "https://abc.tech.local:4443/v4/proxies/1a087d00-12b2-4902-9b19-22faf05dc14a"}

     }

  },

     {

     "objectStorageId": "62184b76-b935-42a9-868e-d55e83f052fa",

     "objectStorageCachePath": "C:\\repos\\1",

     "objectStorageEncryptionEnabled": true,

     "encryptionKeyId": "428fbab8-264a-4452-888f-9bb97775307b",

     "isOutOfSync": false,

     "capacityBytes": 135996108800,

     "freeSpaceBytes": 107011002368,

     "id": "70401fe2-766e-4f2b-a810-9d9ee2655db8",

     "name": "ABC Support",

     "description": "",

     "path": "",

     "retentionType": "ItemLevel",

     "retentionPeriodType": "Daily",

     "dailyRetentionPeriod": 14,

     "retentionFrequencyType": "Daily",

     "dailyTime": "08:00:00",

     "dailyType": "Weekends",

     "proxyId": "1a087d00-12b2-4902-9b19-22faf05dc14a",

     "_links":       {

        "self": {"href": "https://abc.tech.local:4443/v4/backuprepositories/70401fe2-766e-4f2b-a810-9d9ee2655db8"},

        "proxy": {"href": "https://abc.tech.local:4443/v4/proxies/1a087d00-12b2-4902-9b19-22faf05dc14a"}

     }

  }

]

This Document Help Center
User GuideRESTful API ReferencePowerShell ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
I want to report a typo

There is a misspelling right here:

 

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