GET /failoverPlans
Returns a resource representation of a collection of all failover plans configured on backup servers that are connected to Veeam Backup Enterprise Manager.
Tip |
To get a filtered and sorted collection of failover plans, send the GET /query?type=FailoverPlan request. |
Request
To get a list of failover plans configured on backup servers, send the GET HTTP request to the URL of the /failoverPlans resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/failoverPlans |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | 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. |
Accept | False | 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. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message. Possible values:
|
Response Body
In the response body, the REST API returns a representation of the /failoverPlans resource collection.
Example
The example below returns a list of all failover plans configured on backup servers connected to Veeam Backup Enterprise Manager.
Request: GET https://localhost:9398/api/failoverPlans
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <EntityReferences xmlns="http://www.veeam.com/ent/v1.0"> |