This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Protected Virtual Machines
You can get a collection resource representation of all protected virtual machines.
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 all protected virtual machines, send the GET HTTP request to the URL of the /protectedWorkloads/virtualMachines collection.
HTTP Request
GET https://<hostname>:1280/api/v3/protectedWorkloads/virtualMachines |
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 |
|---|---|---|---|---|---|
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 ProtectedVirtualMachine schema.
Example 
The following request returns a representation of all protected virtual machines.
Request: GET https://localhost:1280/api/v3/protectedWorkloads/virtualMachines
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "a947d592-133f-4cd4-a405-0a944164eb85", "backupServerUid": "a849ddcc-4df8-40cc-8251-3b4b4f85ce0d", "organizationUid": "eb2ab9ad-e14a-466c-b042-780ec2cd2178", "jobUid": "f3e3bbc0-b0de-45ae-90ff-f3e87db80b11", "name": "filesrv1", "destination": "reposrv4", "sourceSize": 17180917760, "totalRestorePointSize": 13939543552, "latestRestorePointSize": 17916928, "restorePoints": 8, "latestRestorePointDate": "2020-03-28T03:33:16+03:00", "backupType": "backup" }, { "instanceUid": "412407b2-7f8f-4911-8f45-7b2e793576fb", "backupServerUid": "976d4924-ae52-4cc6-b14b-882eef1451e8", "organizationUid": "9607e7b5-71aa-4c53-8276-9f87e3a1cbab", "jobUid": "276c536f-818b-4415-9b2f-5125ffcd093d", "name": "prodsrv2", "destination": "reposrv9", "sourceSize": 69267881984, "totalRestorePointSize": 118127833088, "latestRestorePointSize": 16880764928, "restorePoints": 7, "latestRestorePointDate": "2020-03-28T03:31:55+03:00", "backupType": "backup" } ] } |