Properties

In this article

    The resources in the /backupRepositories collection have a number of properties that reflect backup repository characteristics. Properties can be used as query parameter values in GET requests.

    Property

    Type

    Description

    id

    integer

    System ID assigned to a backup repository in the Veeam Service Provider Console REST API.

    name

    String

    Name of a backup repository configured in Veeam Backup & Replication or cloud repository configured in Veeam Cloud Connect.

    repositoryUid

    String

    System ID assigned to a repository in Veeam Backup & Replication or Veeam Cloud Connect.

    serverName

    String

    Name of a Veeam backup server that manages a backup repository or cloud repository.

    companyName

    String

    Name of company that uses a backup repository.

    locationName

    String

    Name of company location to which backup repository is assigned.

    capacity

    integer

    Capacity of a backup repository.

    capacityUnits

    String

    Measurement units for capacity of a backup repository.

    Possible values: B (byte) and its multiples formed with metric prefixes.

    freeSpace

    integer

    Free space remaining on a backup repository.

    freeSpaceUnits

    String

    Measurement units for free space remaining on a backup repository.

    Possible values: B (byte) and its multiples formed with metric prefixes.

    backupSize

    integer

    Total amount of backed up data.

    backupSizeUnits

    String

    Measurement units for backed up data.

    Possible values: B (byte) and its multiples formed with metric prefixes.

    healthState

    String

    Repository health state.

    Possible values:

    • OK
    • Warning
    • Error

    backupServerId

    integer

    System ID assigned to a backup server in the Veeam Service Provider Console REST API.

    isServiceProviderRepository

    Boolean

    Indicates whether a repository is owned by a service provider.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property). Can contain links to backup server, tenant and location resources.