GET /query?type=WanAccelerator
Returns a resource representation of a collection of WAN accelerators configured on backup servers connected to Veeam Backup Enterprise Manager. For details, see /wanAccelerators.
Request
To get a list of WAN accelerators, send the GET HTTP request to the query with the type parameter set to WanAccelerator.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/query?type=WanAccelerator |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Optional Parameters
In the query, you can use the following parameters for filtering and sorting.
Parameter | Type | Description |
|---|---|---|
UID | UidType | UID of the WAN accelerator resource, for example: urn:veeam:WanAccelerator:55bd11af-696d-4224-ae9c-0917c851177c. |
Name | String | Name of the WAN accelerator, for example: SourceWanAccelerator. |
Capacity | Long | Size of the global cache (in GB) that was specified for the WAN accelerator in Veeam Backup & Replication, for example: 100. |
ConnectionsCount | Int | Number of connections that are used to transmit data between WAN accelerators. Parameter is set in Veeam Backup & Replication, the default value is 5. |
HighBandwidthModeEnabled | Boolean | Defines if the WAN accelerator operates in the high bandwidth mode. This mode applies simplified algorithms for data deduplication and does not use the global cache. It allows Veeam Backup & Replication to transfer incremental backup data more efficiently in case network bandwidth is greater than 100 Mbps. |
BackupServerUid | UidType | UID of the backup server parent to the WAN accelerator. |
BackupServerName | String | Name of the backup server parent to the WAN accelerator. |
Response
The server returns the following response to the client.
Response Codes
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. Possible values:
|
Response Body
In the response body, the REST API returns a representation of the /wanAccelerators resource collection.
Example
The example below returns an entity resource representation of a collection of WAN accelerators configured on the enterprise06.tech.local backup server. The results are ordered in the acceding order by the Name parameter.
Request: GET https://localhost:9398/api/query?type=WanAccelerator&format=Entities&sortAsc=name&sortAsc=Name&filter=BackupServerName=="enterprise06.tech.local"
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0"> |