Get All Backup Proxies
You can get a collection resource representation of all backup proxies.
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 backup proxies, send the GET HTTP request to the URL of the /infrastructure/backupServers/proxies collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/proxies |
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 BackupProxy schema.
Example 
The following request returns a representation of all backup proxies.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/proxies
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "330b75b9-771d-4ec0-8f12-c3d3b6ced6d7", "name": "Proxy 1", "version": "10.0.0.4461", "backupServerUid": "d7377854-5f7a-49ab-906d-92a71ccacfc4", "isOutOfDate": false, "isDisabled": false, "hostUid": "9ad4e62c-3979-48d8-b69b-04b6276e2352", "hostName": "vbrprox1", "status": "healthy", "type": "vSphere" }, { "instanceUid": "084fe2fa-7bd1-413a-ad6b-bdef35b1884c", "name": "Backup Proxy 2", "version": "10.0.0.4461", "backupServerUid": "f23db653-ba04-4be8-9d3e-4d0c89fcb126", "isOutOfDate": false, "isDisabled": false, "hostUid": "f4b2307e-8a62-48de-9498-df4203c2167a", "hostName": "bckpprx_02", "status": "healthy", "type": "vSphere" } ] } |
