Get All Protected Virtual Machine Replication Restore Points
You can get a collection resource representation of replication restore points created for a protected virtual machine with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a representation of replication restore points created for a specific protected virtual machine, send the GET HTTP request to the URL of the /protectedWorkloads/virtualMachines/{virtualMachineUid}/replicaRestorePoints collection.
HTTP Request
GET https://<hostname>:1280/api/v3/protectedWorkloads/virtualMachines/{virtualMachineUid}/replicaRestorePoints |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
---|---|---|---|---|---|
virtualMachineUid | Path | String (uuid) | Yes | — | Virtual machine UID |
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
Response
The server returns the following response to the client.
Response Code
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: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a collection resource representation based on the ProtectedVirtualMachineReplicaRestorePoint schema.
Example
The following request returns a representation of all replication restore points created for a specific protected virtual machine.
Request: GET https://localhost:1280/api/v3/protectedWorkloads/virtualMachines/4326e5eb-ab21-450e-8301-e4e18ee937dd/replicaRestorePoints
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "92310fb4-57e5-4313-840d-2872a3302e23", "virtualMachineUid": "4326e5eb-ab21-450e-8301-e4e18ee937dd", "jobUid": "60e6d288-83d7-4442-b2f0-0ed97ba65043", "creationDate": "2020-03-28T03:33:16+03:00" }, { "instanceUid": "a3867243-d81b-4b7f-8f30-3c65bb39904f", "virtualMachineUid": "4326e5eb-ab21-450e-8301-e4e18ee937dd", "jobUid": "c0b84253-b97a-42c9-98a8-b3d6cebbfb70", "creationDate": "2020-03-28T03:33:16+03:00" } ] } |