Get All WAN Accelerators Connected to Backup Server
You can get a collection resource representation of all WAN accelerators connected to a Veeam Backup & Replication server 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 all WAN accelerators connected to a specific Veeam Backup & Replication server, send the GET HTTP request to the URL of the /infrastructure/backupServers/{backupServerUid}/wanaccelerators collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/{backupServerUid}/wanaccelerators |
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 |
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 BackupWanAccelerator schema.
Example
The following request returns a representation of all WAN accelerator connected to a Veeam Backup & Replication server with UID f95eeb9b-a9cb-4d58-8c0e-ffd330a482a5.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/f95eeb9b-a9cb-4d58-8c0e-ffd330a482a5/wanaccelerators
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "1bc304d0-822d-4713-9d43-f9775becf695", "name": "WAN", "backupServerUid": "f95eeb9b-a9cb-4d58-8c0e-ffd330a482a5", "version": "10.0.0.4461", "hostUid": "07c8d2df-a808-4f23-93c3-a8a72c35e294", "hostName": "wan_3", "isOutOfDate": false, "status": "healthy" }, { "instanceUid": "b38369f3-e4ac-4df4-91e6-101633fb045f", "name": "WAN Accelerator Server", "backupServerUid": "f95eeb9b-a9cb-4d58-8c0e-ffd330a482a5", "version": "10.0.0.4461", "hostUid": "7c7a1027-af05-44bd-b873-23980e8cee85", "hostName": "wan_srv02", "isOutOfDate": false, "status": "healthy" } ] } |