Returns a collection of cloud failover sessions performed on backup servers connected to Veeam Backup Enterprise Manager. For details, see /cloud/failoverSessions.
To get a list of cloud failover sessions, send the GET HTTP request to the query with the type parameter set to CloudFailoverSession.
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 cloud failover session resource, for example: 475420ee-d045-4493-9869-0a970e08f6f9.
Name of the cloud failover session resource, for example: ABC Company Failover Plan.
Type of the cloud failover session. Possible value: FailoverPlan.
Date and time when the cloud failover session was started. The parameter accepts only UTC-formatted DateTime values.
Date and time when the cloud failover session was ended. The parameter accepts only UTC-formatted DateTime values
State of the cloud failover session. Possible values:
Result of the cloud failover session. Possible values:
Reason for which the cloud replication session has been completed with the Failed result.
UID of the backup server parent to the cloud failover session resource.
Name of the backup server parent to the cloud failover session 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 /cloud/failoverSessions resource collection.
The example below returns an entity resource representation of a collection of failed cloud failover sessions. The results are ordered in the descending order by the CreationTime parameter.