POST v1/core/accounts/{accId}/agents/{agtId}/tunnels/host

Create an Agent Host tunnel

Request Information

Parameters

NameDescriptionAdditional information
accId

Define this parameter in the request URI.

agtId

Define this parameter in the request URI.

tunnel

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Name": "sample string 2",
  "NextHopAddress": "sample string 3",
  "LinkCost": 4,
  "EnableRouting": true,
  "DHCP": 6
}

text/javascript

Sample:
{"ID":1,"Name":"sample string 2","NextHopAddress":"sample string 3","LinkCost":4,"EnableRouting":true,"DHCP":6}

application/xml, text/xml

Sample:
<AgentHostTunnel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <DHCP>6</DHCP>
  <EnableRouting>true</EnableRouting>
  <ID>1</ID>
  <LinkCost>4</LinkCost>
  <Name>sample string 2</Name>
  <NextHopAddress>sample string 3</NextHopAddress>
</AgentHostTunnel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AgentHostTunnel'.

application/bson

Sample:
sIDNamesample string 2NextHopAddresssample string 3LinkCostEnableRoutingDHCP

Response Information

Response body formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "ID": 1,
    "Name": "sample string 2",
    "NextHopAddress": "sample string 3",
    "LinkCost": 4,
    "EnableRouting": true,
    "DHCP": 6
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:
{"Success":true,"Data":{"ID":1,"Name":"sample string 2","NextHopAddress":"sample string 3","LinkCost":4,"EnableRouting":true,"DHCP":6},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:
<PBNBReturnOfAgentHostTunnelCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <DHCP>6</DHCP>
    <EnableRouting>true</EnableRouting>
    <ID>1</ID>
    <LinkCost>4</LinkCost>
    <Name>sample string 2</Name>
    <NextHopAddress>sample string 3</NextHopAddress>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfAgentHostTunnelCA1DLPoZ>

application/bson

Sample:
�SuccessDatasIDNamesample string 2NextHopAddresssample string 3LinkCostEnableRoutingDHCPErrorCodeErrorDescriptionsample string 3Metasample string 4