Getting Backup Repositories

In this article

    You can get a resource representation of a backup repository with the specified ID.

    Request

    GET https://<hostname>:4443/v5/BackupRepositories/{repositoryId}

    Request Headers

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

    Request Parameters

    The following parameter must be specified in the URL of the request:

    Parameter

    Type

    Description

    repositoryId

    string

    Specifies the identification number of the backup repository. For more information on how to get this parameter, see Getting Backup Repositories.

    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

    The response contains the following information:

    Property

    Type

    Description

    id

    string

    Specifies the ID of the backup repository.

    name

    string

    Specifies the name of the backup repository.

    proxyId

    string

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

    path

    string

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

    description

    string

    Specifies the description of the backup repository.

    retentionType

    retentionType

    Specifies the type of the retention policy:

    • ItemLevel
    • SnapshotBased

    retentionPeriodType

    string

    Specifies the retention period type:

    • Daily
    • Monthly
    • Yearly

    dailyRetentionPeriod

    string

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

    monthlyRetentionPeriod

    string

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

    yearlyRetentionPeriod

    string

    Specifies the retention period in years:

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

    This property is valid if retentionPeriodType is set to Yearly.

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

    retentionFrequencyType

    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.

    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:

    • 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:

    • First
    • Second
    • Third
    • Fourth
    • Last

    monthlyDayOfWeek

    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

    capacityBytes

    integer

    Capacity of a backup repository.

    freeSpaceBytes

    integer

    Free space remaining on a backup repository.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Examples

    Example 1

    The following request returns a resource representation of a backup repository with the ID 5729d9cf-abfa-4077-9dd5-f5a888b98147.

    Request:

    GET https://abc.tech.local:4443/v5/BackupRepositories/5729d9cf-abfa-4077-9dd5-f5a888b98147

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

      "id": "5729d9cf-abfa-4077-9dd5-f5a888b98147",

      "name": "ABC Support",

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

      "retentionPeriodType": "Daily",

      "dailyRetentionPeriod": "14",

      "retentionFrequencyType": "Daily",

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

      "description": "Daily",

      "retentionType": "ItemLevel",

      "dailyType": "Weekends",

      "path": "C:\\ABC_support",

      "capacityBytes": 128479916032,

      "freeSpaceBytes": 111512793088,

      "_links": {

        "self": {

          "href": "https://abc.tech.local:4443/v5/BackupRepositories/22318b1b-3249-48b3-b340-61b783c1222c"

         },

        "proxy": {

          "href": "https://abc.tech.local:4443/v5/Proxies/817e8616-27c3-46db-a18c-1da0b29e6e5a"

        }

      }

    }