Getting Backup Repositories

In this article

    You can get a collection of backup repositories.

    Request

    GET https://<hostname>:4443/v6/BackupRepositories?proxyId=<string>&longTerm=<boolean>

    Request Headers

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

    Request Parameters

    The following optional parameters can be specified in the URL of the request:

    Parameter

    Type

    Description

    proxyId

    string

    Specifies the identification number of the backup proxy server. For more information on how to get this parameter, see Getting Backup Proxy Servers.

    longTerm

    boolean

    Defines the representation of the backup repository properties that will be returned to the client. The following values are available:

    • true — the controller returns only properties of backup repositories extended with an archive object storage.
    • false — the controller returns properties of backup repositories extended/not extended with an object storage repository.

    Request Body

    None.

    Request Example

    Request:

    https://abc.tech.local:4443/v6/BackupRepositories?proxyId=89e8c35e-6c73-4f46-a37d-b365e513f7c6&longTerm=true

     

    Request Header:

    Authorization: Bearer <Access-Token>

    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

    In the response body, the server returns a resource representation of the /BackupRepositories resource. The response body contains the following properties:

    Property

    Type

    Description

    objectStorageId

    string

    Specifies the object storage ID.

    objectStorageCachePath

    string

    Specifies a path to the directory of the backup repository on a backup proxy server.

    objectStorageEncryptionEnabled

    boolean

    Defines whether the object storage encryption is enabled.

    encryptionKeyId

    string

    Specifies the encryption key ID.

    isOutOfSync

    boolean

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

    capacityBytes

    integer

    Specifies the size of the backup repository in Bytes.

    freeSpaceBytes

    integer

    Specifies the available space on the backup repository in Bytes.

    id

    string

    Specifies the backup repository ID.

    name

    string

    Specifies a name of the backup repository.

    description

    string

    Specifies the backup repository description.

    path

    string

    Specifies a path to the directory where backups are stored.

    retentionType

    string

    Specifies the type of the retention policy. The following types are available:

    • ItemLevel
    • SnapshotBased

    retentionPeriodType

    string

    Specifies the retention period type. The following types are available:

    • Daily
    • Monthly
    • Yearly

    retentionFrequencyType

    string

    Specifies clean-up schedule type. The following types are available:

    • Daily. Veeam Backup for Microsoft 365 checks and removes the outdated backups once a day. Use the dailyTime property to set the time of the day for performing clean-up. Use the dailyType property to set the days for performing clean-up.
    • Monthly. Veeam Backup for Microsoft 365 checks and removes the outdated backups once a month. Use the monthlyTime property to set the time of the day for performing clean-up. Use the monthlyDaynumber and monthlyDayofweek properties to set the day for performing clean-up.

    dailyRetentionPeriod

    integer

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

    monthlyRetentionPeriod

    integer

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

    yearlyRetentionPeriod

    string

    Specifies the retention period in years. The following values are available:

    • Year1
    • Years2
    • Years3
    • Years5
    • Years7
    • Years10
    • Years25
    • Keep

    This property is valid if retentionPeriodType is set to Yearly.

    If set to Keep, the backup job will back up all selected items and will never remove them.

    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. The following values are available:

    • Sunday
    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday
    • Everyday
    • Workdays
    • Weekends

    monthlyTime

    UTC

    For Monthly clean-up schedule.

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

    monthlyDaynumber

    string

    For Monthly clean-up schedule.

    Specifies the order number for the day of the week when clean-up must be performed. The following values are available:

    • First
    • Second
    • Third
    • Fourth
    • Last

    monthlyDayofweek

    string

    For Monthly clean-up schedule.

    Specifies the day of the week when clean-up must be performed. The following values are available:

    • Sunday
    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday

    proxyId

    string

    Specifies the backup proxy ID.

    isLongTerm

    boolean

    Defines whether the backup repository is extended with an archive object storage.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    The example returns a list of all backup repositories added to Veeam Backup for Microsoft 365.

    Request:

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

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [

     {

       "objectStorageId": "838cd507-76ff-4074-a707-e5fa38f5b348",

       "objectStorageCachePath": "C:\\BackupRepo",

       "objectStorageEncryptionEnabled": false,

       "isOutOfSync": false,

       "capacityBytes": 138990841856,

       "freeSpaceBytes": 104534863872,

       "id": "5f7c94d0-c339-46f1-9b0f-2b9763ba83de",

       "name": "Backup Repository",

       "description": "",

       "retentionType": "SnapshotBased",

       "retentionPeriodType": "Yearly",

       "yearlyRetentionPeriod": "Years3",

       "retentionFrequencyType": "Monthly",

       "monthlyTime": "23:00:00",

       "monthlyDaynumber": "First",

       "monthlyDayofweek": "Sunday",

       "proxyId": "89e8c35e-6c73-4f46-a37d-b365e513f7c6",

       "isLongTerm": false,

       "_links": {

         "self": {

           "href": "/v6/backuprepositories/5f7c94d0-c339-46f1-9b0f-2b9763ba83de"

         },

         "proxy": {

           "href": "/v6/proxies/89e8c35e-6c73-4f46-a37d-b365e513f7c6"

         }

       }

     },

     {

       "isOutOfSync": false,

       "capacityBytes": 138990841856,

       "freeSpaceBytes": 104534863872,

       "id": "16c637fe-9aad-4067-a8d1-5287a6390775",

       "name": "Default Backup Repository",

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

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

       "retentionType": "SnapshotBased",

       "retentionPeriodType": "Yearly",

       "yearlyRetentionPeriod": "Years3",

       "retentionFrequencyType": "Daily",

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

       "dailyType": "Everyday",

       "proxyId": "89e8c35e-6c73-4f46-a37d-b365e513f7c6",

       "_links": {

         "self": {

           "href": "/v6/backuprepositories/16c637fe-9aad-4067-a8d1-5287a6390775"

         },

         "proxy": {

           "href": "/v6/proxies/89e8c35e-6c73-4f46-a37d-b365e513f7c6"

         }

       }

     },

     {

       "objectStorageId": "ffb0076b-b049-4034-aeb2-ec4d1ebc6fab",

       "objectStorageCachePath": "C:\\BackupArchiveRepo",

       "objectStorageEncryptionEnabled": false,

       "isOutOfSync": false,

       "capacityBytes": 138990841856,

       "freeSpaceBytes": 104534863872,

       "id": "f93dc1b5-5ecd-45ce-b4dd-5519160b6713",

       "name": "Backup Archive Repository",

       "description": "",

       "retentionType": "SnapshotBased",

       "retentionPeriodType": "Yearly",

       "yearlyRetentionPeriod": "Years3",

       "retentionFrequencyType": "Monthly",

       "monthlyTime": "23:00:00",

       "monthlyDaynumber": "First",

       "monthlyDayofweek": "Sunday",

       "proxyId": "89e8c35e-6c73-4f46-a37d-b365e513f7c6",

       "isLongTerm": true,

       "_links": {

         "self": {

           "href": "/v6/backuprepositories/f93dc1b5-5ecd-45ce-b4dd-5519160b6713"

         },

         "proxy": {

           "href": "/v6/proxies/89e8c35e-6c73-4f46-a37d-b365e513f7c6"

         }

       }

     }

    ]