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

General

In this article

    The following properties are present in all resources from the /backupPolicies collection:

    Property

    Type

    Description

    id

    integer

    System ID assigned to a backup policy in Veeam Availability Console RESTful API.

    name

    string

    Name of a backup policy configured in Veeam Availability Console.

    retention

    integer

    Number of restore points to keep for the backup job.

    operationMode

    string

    Indicates the operation mode of a backup agent.

    Possible values:

    accessType

    string

    Indicates the backup policy access type.

    Possible values:

    • Private
    • Public

    backupMode

    string

    Indicates backup mode settings.

    Possible values:

    destinationType

    string

    Target storage for the backup files.

    Possible values:

    advancedSettings

    AdvancedSettings

    Indicates advanced backup agent job and storage settings.

    type

    string

    Indicates the type of a backup policy.

    Possible values:

    • Predefined
    • Created by Provider
    • Created by Client
    • Created by Reseller

    osType

    string

    Indicates the type of OS to which a backup policy is applied.

    Possible values:

    • Workstation
    • Server

    Only present in a response from a collection of backup policies.

    description

    string

    Description of a backup policy.

    tenantsCount

    integer

    Number of companies or departments using a backup policy.

    modifiedDate

    string

    Date when a backup policy was last modified.

    Date string is formatted in accordance with ISO 8601.

    createdBy

    string

    Name of a tenant or cloud provider which created a backup policy.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    I want to report a typo

    There is a misspelling right here:

     

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