Returns a resource representation of a collection of failover plans configured on backup servers that are connected to Veeam Backup Enterprise Manager. For details, see /failoverPlans.
To get a list of failover plans, send the GET HTTP request to the query with the type parameter set to FailoverPlan.
The request contains the following headers:
The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security.
Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format.
In the query, you can use the following parameters for filtering and sorting.
UID of the failover plan, for example: urn:veeam:FailoverPlan:ae01e36f-32a3-4095-95fa-09a2af744009.
Name of the failover plan, for example: SQL Failover Plan.
Description of the failover plan specified at the time of the failover plan creation.
UID of the backup server parent to the failover plan resource.
Name of the backup server parent to the failover plan resource.
The server returns the following response to the client.
A successfully completed operation returns response code 200 OK.
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
The length of the response body.
The media type and syntax of the request body message. Possible values:
In the response body, the REST API returns a representation of the /failoverPlans resource collection.
The example below returns a list of failover plans configured on backup servers connected to Veeam Backup Enterprise Manager.
The example below returns an entity reference resource representation of a collection of failover plans created on the backup server with name enterprise06.tech.local. The results are ordered in the acceding order by the Name parameter.