Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

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 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 Admin
  • Created by Provider
  • Created by Department Admin
  • Created by Client

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).

Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference