This is an archive version of the document. To get the most up-to-date information, see the current version.

/BackupRepositories/{repositoryId}

In this article

    Represents a backup repository having a specified ID.

    Resource URL

    The URL of the reference resource representation:

    https://<Backup-Office365>:4443/v3/BackupRepositories/{repositoryId}

    Related Resources

    /Proxies/{proxyId}

    Methods

    The following methods are supported for the /BackupRepositories/{repositoryId} resource:

    Properties

    The /BackupRepositories/{repositoryId} resource has the following properties:

    Property

    Type

    Description

    Id

    string

    Specifies the ID of the backup repository.

    For example, "id": "5f8d4793-6c87-4cb3-a5c4-0cc06387b64f".

    Name

    string

    Specifies the name of the backup repository.

    For example, "name": "ABC Support".

    ProxyId

    string

    Specifies the ID of a backup proxy. Veeam Backup for Microsoft Office 365 will create a backup repository on this proxy.

    For example, "proxyId": "5a905bb5-9071-433c-9d2f-f805d4da2cf4".

    Path

    string

    Specifies the full path to the folder where the backups will be stored.

    For example, "path": "C:\\ABC_support".

    Description

    string

    Specifies the description of the backup repository.

    For example, "description": "Daily".

    RetentionType

    retentionType

    Specifies the type of the retention policy:

    • ItemLevel
    • SnapshotBased

    For example, "retentionType": "ItemLevel"

    Retention
    Period
    Type

    string

    Specifies the retention period type:

    • Daily
    • Monthly
    • Yearly

    For example, "retentionPeriodType": "Daily".

    Daily
    Retention
    Period

    string

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

    For example, "dailyRetentionPeriod": "14".

    Monthly
    Retention
    Period

    string

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

    For example, "monthlyRetentionPeriod": "6".

    Yearly
    Retention
    Period

    string

    Specifies the retention period in years:

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

    This property is valid if retentionPeriodType is set to Yearly.

    If you select KeepForever, the backup job will back up all selected items and will never remove them.

    For example, "yearlyRetentionPeriod": "KeepForever".

    Retention
    Frequency
    Type

    string

    Specifies clean-up schedule type:

    • Daily: to check and remove the outdated backups once a day. Use DailyTime property to set the time of the day for performing clean-up. Use DailyType property to set the days for performing clean-up.
    • Monthly: to check and remove the outdated backups once a month. Use MonthlyTime property to set the time of the day for performing clean-up. Use MonthlyDayNumber and MonthlyDayOfWeek properties to set the day for performing clean-up.

    For example, "retentionFrequencyType": "Monthly".

    DailyTime

    UTC

    For daily clean-up schedule.

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

    For example, "dailyTime": "08:00:00".

    DailyType

    string

    For daily clean-up schedule.

    Specifies the days when clean-up must be performed:

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

    For example, "dailyType": "Workdays".

    MonthlyTime

    UTC

    For monthly clean-up schedule.

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

    For example, "monthlyTime": "00:00:00".

    Monthly
    DayNumber

    string

    For monthly clean-up schedule.

    Specifies the order number for the day of the week when clean-up must be performed:

    • First
    • Second
    • Third
    • Fourth
    • Last

    For example, "monthlyDayNumber": "Last".

    Monthly
    DayOfWeek

    string

    For monthly clean-up schedule.

    Specifies the day of the week when clean-up must be performed:

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

    For example, "monthlyDayOfWeek": "Sunday".

    CapacityBytes

    int

    Capacity of a backup repository.

    For example, "capacityBytes": "128479916032".

    FreeSpaceBytes

    int

    Free space remaining on a backup repository.

    For example, "freeSpaceBytes": "111512489984".

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Resource Representation

    The /BackupRepositories/{repositoryId} resource has the following representation:

    {

      "id": "5f8d4793-6c87-4cb3-a5c4-0cc06387b64f",

      "name": "ABC Sales Backups",

      "proxyId": "69f00673-0cd5-46fa-911a-24cfe7ec19be",

      "retentionPeriod": "Years3",

      "retentionFrequencyType": "Daily",

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

      "description": "Monthly Reports",

      "retentionType": "ItemLevel",

      "dailyType": "Everyday",

      "path": "C:\\Backups_ABC",

      "capacityBytes": 128479916032,

      "freeSpaceBytes": 105374814208,

      "_links": {

        "self": {

          "href": "https://support.east.local:4443/v3/BackupRepositories/5f8d4793-6c87-4cb3-a5c4-0cc06387b64f"

         },

        "proxy": {

          "href": "https://support.east.local:4443/v3/Proxies/69f00673-0cd5-46fa-911a-24cfe7ec19be"

         }

       }

     }

    I want to report a typo

    There is a misspelling right here:

     

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