POST v1/core/Accounts/{accId}/routes/staticaddressing

Set a static route

Request Information

Parameters

NameDescriptionAdditional information
accId
the account id

Define this parameter in the request URI.

item
the new static route details

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "Status": "up|down",
  "Source": "manual|agent|ripped",
  "Description": "sample string 1",
  "Agent": "sample string 2",
  "Destination": "sample string 3",
  "Mask": "sample string 4",
  "NextHop": "sample string 5",
  "Metric": 6
}

text/javascript

Sample:
{"Status":0,"Source":0,"Description":"sample string 1","Agent":"sample string 2","Destination":"sample string 3","Mask":"sample string 4","NextHop":"sample string 5","Metric":6}

application/xml, text/xml

Sample:
<NetworkRoute xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Agent>sample string 2</Agent>
  <Description>sample string 1</Description>
  <Destination>sample string 3</Destination>
  <Mask>sample string 4</Mask>
  <Metric>6</Metric>
  <NextHop>sample string 5</NextHop>
  <Source>manual|agent|ripped</Source>
  <Status>up|down</Status>
</NetworkRoute>

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 'NetworkRoute'.

application/bson

Sample:
�StatusSourceDescriptionsample string 1Agentsample string 2Destinationsample string 3Masksample string 4NextHopsample string 5Metric

Response Information

Response body formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "Status": "up|down",
    "Source": "manual|agent|ripped",
    "Description": "sample string 1",
    "Agent": "sample string 2",
    "Destination": "sample string 3",
    "Mask": "sample string 4",
    "NextHop": "sample string 5",
    "Metric": 6
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:
{"Success":true,"Data":{"Status":0,"Source":0,"Description":"sample string 1","Agent":"sample string 2","Destination":"sample string 3","Mask":"sample string 4","NextHop":"sample string 5","Metric":6},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:
<PBNBReturnOfNetworkRouteCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <Agent>sample string 2</Agent>
    <Description>sample string 1</Description>
    <Destination>sample string 3</Destination>
    <Mask>sample string 4</Mask>
    <Metric>6</Metric>
    <NextHop>sample string 5</NextHop>
    <Source>manual|agent|ripped</Source>
    <Status>up|down</Status>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfNetworkRouteCA1DLPoZ>

application/bson

Sample:
!SuccessData�StatusSourceDescriptionsample string 1Agentsample string 2Destinationsample string 3Masksample string 4NextHopsample string 5MetricErrorCodeErrorDescriptionsample string 3Metasample string 4