GET /wanAccelerators/{ID}

In this article

    Returns a resource representation of a WAN accelerator having the specified ID.

    Request

    To get a resource representation of the WAN accelerator, send the GET HTTP request to the URL of the /wanAccelerators/{ID} resource:

    HTTP Request

    GET https://<Enterprise-Manager>:9398/api/wanAccelerators/{ID}

    or

    GET https://<Enterprise-Manager>:9398/api/wanAccelerators/{ID}?format=Entity

    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:

    • application/xml — the client can send this value in the header to accept response in the XML format.
    • application/json — the client must send this value in the header to accept the request in the JSON format.

    If the request does not contain the header, the server will return the response in the XML format.

    Request Body

    None.

    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:

    • application/xml
    • application/json

    Response Body

    In the response body, Veeam Backup Enterprise Manager returns an entity or an entity reference of the /wanAccelerators/{ID} resource. The resource entity contains the following parameters and links.

    Parameters

    Element

    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.

    Description

    String

    Name of the WAN accelerator, for example: WAN Accelerator in Columbus.

    OutOfDate

    Boolean

    Defines if the WAN accelerator is out of date.

    Version

    String

    Veeam Backup & Replication version of the WAN accelerator, for example: 11.0.

    Capacity

    Long

    Size of the global cache (in GB) specified for the WAN accelerator, for example: 100.

    TrafficPort

    Int

    Port over which WAN accelerators communicate with each other. By default, port 6165 is used.

    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.

    CachePath

    String

    Path to the folder where service files (for source and target WAN accelerators) and global cache data (for target WAN accelerator) are stored.

    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.

    To view query parameters that you can use for filtering or sorting, see GET /query?type=WanAccelerator.

    Links

    Reference

    Relationship

    Description

    /backupServers/{ID}

    Up

    URL of the /backupServers/{ID} resource — a backup server where the WAN accelerator was created.

    /wanAccelerators//{ID}

    Alternate

    Alternate URL of the /wanAccelerators/{ID} resource.

    Example

    The example below returns an entity reference representation of the WAN accelerator having ID d6af7637-de80-4a10-94cc-a2acec188931.

    Request:

    GET https://localhost:9398/api/wanAccelerators/d6af7637-de80-4a10-94cc-a2acec188931?format=Entity

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <?xml version="1.0" encoding="utf-8"?>
    <WanAccelerator xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Href="https://enterprise06.tech.local:9398/api/wanAccelerators/d6af7637-de80-4a10-94cc-a2acec188931?format=Entity" Type="WanAccelerator" Name="enterprise04.tech.local" UID="urn:veeam:WanAccelerator:d6af7637-de80-4a10-94cc-a2acec188931" xmlns="http://www.veeam.com/ent/v1.0">
       <Links>
           <Link Href="https://enterprise06.tech.local:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563" Name="enterprise06.tech.local" Type="BackupServerReference" Rel="Up" />
           <Link Href="https://enterprise06.tech.local:9398/api/wanAccelerators/d6af7637-de80-4a10-94cc-a2acec188931" Name="enterprise04.tech.local" Type="WanAcceleratorReference" Rel="Alternate" />
       </Links>
       <Description>WAN Accelerator in Columbus</Description>
       <OutOfDate>false</OutOfDate>
       <Version>11.0</Version>
       <Capacity>100</Capacity>
       <TrafficPort>6165</TrafficPort>
       <ConnectionsCount>5</ConnectionsCount>
       <CachePath>E:\VeeamWAN</CachePath>
       <HighBandwidthModeEnabled>false</HighBandwidthModeEnabled>
    </WanAccelerator>