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

Destination Type

Depending on the value of the destinationType property the /BackupPolicies/{ID} resource can have additional properties.

LocalStorage

If the destinationType property has value localStorage the /BackupPolicies/{ID} resource has the following additional properties:

Property

Type

Description

path

string

Indicates the path at which a local storage is located.

SharedFolder

If the destinationType property has value sharedFolder the /BackupPolicies/{ID} resource has the following additional properties:

Property

Type

Description

path

string

Indicates the path at which a shared folder is located.

credentials

Credentials

Indicates credentials to access a shared folder.

cacheEnabled

boolean

Indicates whether backup cache is enabled for a job.

Backup cache has a number of limitations. For more details, see Limitations for Backup Cache.

cachePath

string

Indicates the path at which a cache folder is located.

Only present if the cacheEnabled property has value true.

cacheSize

integer

Backup cache size.

Only present if the cacheEnabled property has value true.

cacheSizeUnits

string

Measurement units for backup cache size.

Possible values:

  • GB
  • TB

Only present if the cacheEnabled property has value true.

BackupRepository

If the destinationType property has value backupRepository the /BackupPolicies/{ID} resource has the following additional properties:

Property

Type

Description

credentials

Credentials

Indicates credentials to access a backup repository.

serverName

string

Name or IP address of a Veeam Backup Server that manages a backup repository.

serverPort

integer

Connection port of a Veeam Backup Server that manages a backup repository.

repositoryName

string

Name of a backup repository.

cacheEnabled

boolean

Indicates whether backup cache is enabled for a job.

cachePath

string

Indicates the path at which a cache folder is located.

Only present if the cacheEnabled property has value true.

cacheSize

integer

Backup cache size.

Only present if the cacheEnabled property has value true.

cacheSizeUnits

string

Measurement units for backup cache size.

Possible values:

  • GB
  • TB

Only present if the cacheEnabled property has value true.

CloudRepository

If the destinationType property has value cloudRepository the /BackupPolicies/{ID} resource has the following additional properties:

Property

Type

Description

quotaSize

integer

Size of quota for each backup agent pointed to the cloud repository.

quotaSizeUnits

string

Measurement units for size of quota for each backup agent pointed to the cloud repository.

Possible values:

  • GB
  • TB

cacheEnabled

boolean

Indicates whether backup cache is enabled for a job.

cachePath

string

Indicates the path at which a cache folder is located.

Only present if the cacheEnabled property has value true.

cacheSize

integer

Backup cache size.

Only present if the cacheEnabled property has value true.

cacheSizeUnits

string

Measurement units for backup cache size.

Possible values:

  • GB
  • TB

Only present if the cacheEnabled property has value true.

 

Veeam Large Logo

Deployment Guide

Migration Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Evaluator's Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Evaluator's Guide for Enterprises

RESTful API Reference