Get All Protected Computers Managed By Backup Server
You can get a collection resource representation of all protected computers managed by Veeam Backup & Replication servers.
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 computers managed by Veeam Backup & Replication servers, send the GET HTTP request to the URL of the /protectedWorkloads/computersManagedByBackupServer collection.
HTTP Request
GET https://<hostname>:1280/api/v3/protectedWorkloads/computersManagedByBackupServer |
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 ProtectedComputerManagedByBackupServer schema.
Example
The following request returns a representation of all protected computers managed by Veeam Backup & Replication servers.
Request: GET https://localhost:1280/api/v3/protectedWorkloads/computersManagedByBackupServer
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "backupServerUid": "2d845c8f-f43a-452e-8e64-b31fd93f2c3c", "managementAgentUid": "00000000-0000-0000-0000-000000000000", "organizationUid": "292339cb-f02c-43a4-9d47-621e58dff832", "name": "sqlsrv03", "ipAddresses": [ "172.17.53.35" ], "platformType": "windows", "operationMode": "server", "latestRestorePointDate": "2020-03-30T19:00:42.0000000+00:00", "sourceSize": 25659658240, "totalRestorePointSize": 27561675776, "latestRestorePointSize": 789129216 }, { "backupServerUid": "08bf4ea6-81dd-4ceb-9148-1f425a9dc25a", "managementAgentUid": "00000000-0000-0000-0000-000000000000", "organizationUid": "1d6e3463-0d8b-4191-b44a-c3cc3b16a5c8", "name": "win03", "ipAddresses": [ "172.24.31.77" ], "platformType": "windows", "operationMode": "workstation", "latestRestorePointDate": "2020-03-30T19:10:17.0000000+00:00", "sourceSize": 17585807360, "totalRestorePointSize": 22779074560, "latestRestorePointSize": 1055425024 } ] } |