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

General

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 the Veeam Service Provider Console REST API.

name

String

Name of a backup policy configured in Veeam Service Provider 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).