(GET) /wanAccelerators/{ID}
Returns a resource representation of a WAN accelerator having the specified ID.
Request
To get a resource representation of the WAN accelerator, you need to send the GET HTTP request to the URL of the /wanAccelerators/{ID} resource:
HTTP Request
or
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. To learn more, see Authentication and Security. |
Request Body
None.
Query Parameters
The following parameters can be used in queries:
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
UID | URN | ID of the WAN accelerator resource, for example: urn:veeam:WanAccelerator:55bd11af-696d-4224-ae9c-0917c851177c. | True | True |
Name | String | Name of the WAN accelerator, for example: SourceWanAccelerator. | True | True |
Capacity | Long | Size of the global cache (in GB) that was specified for the WAN accelerator in Veeam Backup & Replication, for example: 100. | True | True |
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. | True | True |
BackupServerUid | URN | ID of the Veeam backup server parent to the WAN accelerator. | True | True |
BackupServerName | String | Name of the Veeam backup server parent to the WAN accelerator. | True | True |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 Success.
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/xml. |
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /wanAccelerators/{ID} resource.
Example
The example below returns an entity reference representation of the WAN accelerator having ID 55bd11af-696d-4224-ae9c-0917c851177c.
Request: GET http://localhost:9399/api/wanAccelerators/55bd11af-696d-4224-ae9c-0917c851177c
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 Success
Response Body: <EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="WanAcceleratorReference" Href="http://localhost:9399/api/wanAccelerators/55bd11af-696d-4224-ae9c-0917c851177c" Name="172.16.13.45" UID="urn:veeam:WanAccelerator:55bd11af-696d-4224-ae9c-0917c851177c"> |