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

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

name

String

Name of a failover plan configured by a company.

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