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

Properties

The resources in the /FailoverPlans collection have a number of properties that reflect failover plan settings. Properties can be used for POST requests and as query parameter values in GET requests.

Property

Type

Description

id

string

System ID assigned to a failover plan in Veeam Availability Console RESTful API.

name

string

Name of a failover plan configured by a tenant.

location

string

Location of a company or department for which a failover plan is configured.

serverName

string

Name of a backup server on which a failover plan is configured.

vmCount

integer

Number of VMs included in a failover plan.

type

string

Type of a failover plan.

Possible values:

  • Cloud
  • Local

state

string

State of a failover plan.

Possible values:

  • In progress
  • Undo in progress
  • Completed
  • Ready
  • Failed
  • Undo failed

actions

array

Actions performed by the POST method.

Available actions:

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

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