Start or Stop a Route's Destination

Use this command to start or stop a destination within a route.

Note

You must include all route destinations, even those not being started or stopped. If destinations are excluded, they will be deleted from the route.

Authorizations: Administrator, Operator

Requests

POST /api/devices/[Device ID]/updates
cookie: sessionID: [Session ID]

{ 
 "action": "update",
 "deviceID": "[Device ID]", 
 "elementType": "route",
 "elementID": "[Route ID]",
 "fields":
   {
    "name": "[Route name]",
    "source":
      {
        "name": "[Source name]",
        "id": "[Source ID]",
        "address": "0.0.0.0",
        "port": 1234
      },
      "destinations": [
        {
          "name": "[Destination name]",
          "id": "[Destination ID]",
          "action": "[Command]",
          "address": "10.69.12.148",
          "port": 4900
        },
       (other destinations not being started/stopped)
      ]
   }
}

Parameters

Name	Type	Description
action	update	Update the specified element type.
deviceID	string	Device ID retrieved via the Get Device Info command.
elementType	route	Update a route element.
elementID	string	Route ID retrieved via the Get Device Configuration command.
name	string	Name of route.
source	object	Source object model. See Source Object Model for definition. Tip Only the fields shown above are required.
destinations	object	Destination object model. See Destinations Object Model for definition. Tip Only the fields shown above are required.

Response

{
  "status": "[success message]"
}