Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

Get a Network Extension Appliance

You can get a representation of a network extension appliance with the specified ID.


To get a representation of a network extension appliance, send the GET HTTPS request to the URL of the /Tenants/{ID}/ReplicaResources/NetworkExtensionAppliance/{ID} resource.

HTTP Request

GET https://<Availability-Console>:1281/v2/Tenants/{ID}/ReplicaResources/NetworkExtensionAppliance/{ID}

Request Headers

The request header must contain the authorization token for the current logon session.


The server returns the following response to the client.

Response Code

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.




The length of the response body.


The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Availability Console returns a representation of the /Tenants/{ID}/ReplicaResources/NetworkExtensionAppliance/{ID} resource.

Example Get a Network Extension Appliance

The following request returns a network extension appliance with id BackupTenantNetworkAppliance:bd96471c-70c6-4228-99a4-e55060ed07181332c8cc-c669-41a7-8d4d-a89a11c79083 configured for a company with ID 2.


GET https://localhost:1281/v2/Tenants/2/ReplicaResources/NetworkExtensionAppliance/BackupTenantNetworkAppliance:bd96471c-70c6-4228-99a4-e55060ed07181332c8cc-c669-41a7-8d4d-a89a11c79083


Request Header:

Authorization: Bearer <Access-Token>


Response Code:

200 Success


Response Body:


   "id": "BackupTenantNetworkAppliance:bd96471c-70c6-4228-99a4-e55060ed07181332c8cc-c669-41a7-8d4d-a89a11c79083",

   "name": "Network Extension Appliance Alpha_1(esx02)",

   "hostName": "",

   "externalNetworkName": "VM Network",

   "dhcpEnabled": false,

   "ipAddress": "",

   "subnetMask": "",

   "defaultGateway": "",

   "_links": {

     "self": {

       "href": ""




Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference