This is an archive version of the document. To get the most up-to-date information, see the current version.Get Backup Proxy
You can get a resource representation of a backup proxy 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 a backup proxy, send the GET HTTP request to the URL of the /infrastructure/backupServers/{backupServerUid}/proxies/{proxyUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/{backupServerUid}/proxies/{proxyUid} |
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 |
|---|---|---|---|---|---|
backupServerUid | Path | String (uuid) | Yes | — | Backup server UID |
proxyUid | Path | String (uuid) | Yes | — | Proxy UID |
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 resource representation based on the BackupProxy schema.
Example 
The following request returns a representation of a backup proxy with UID bc04d2e5-dd4c-4f85-af0e-424106a32a75.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/f95eeb9b-a9cb-4d58-8c0e-ffd330a482a5/proxies/bc04d2e5-dd4c-4f85-af0e-424106a32a75
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "bc04d2e5-dd4c-4f85-af0e-424106a32a75", "name": "Proxy 1", "version": "10.0.0.4461", "backupServerUid": "f95eeb9b-a9cb-4d58-8c0e-ffd330a482a5", "isOutOfDate": false, "isDisabled": false, "hostUid": "9ad4e62c-3979-48d8-b69b-04b6276e2352", "hostName": "vbrprox1", "status": "healthy", "type": "vSphere" } } |