POST: Create a Router - AWS Elemental Conductor Live 3

This is version 3.17 of the AWS Elemental Conductor Live 3 documentation. This is the latest version. For prior versions, see the Previous Versions section of AWS Elemental Conductor Live 3 Documentation.

POST: Create a Router

This request creates a new router to correspond to a router that is connected to HD-SDI inputs on one or more AWS Elemental Live nodes. (The same router can have connections to several nodes.)

HTTP Request and Response

Request URL

POST http://<Conductor IP address>/routers

Call Header

  • Accept: Set to application/xml

  • Content-Type: Set to application/xml

If you are implementing user authentication, you must also include three authorization headers; see Header Content for User Authentication.

Request Body

The request body is XML content consisting of one router element, consisting of the following elements.

Element Value Description
name String This name appears in the Inputs drop-down list.
ip String The IP address without any protocol.
max_inputs Integer The number of inputs you want to use on this router. This number must be less than or equal to the number of physical inputs on the router.
max_outputs Integer The number of outputs you want to use on this router. This number must be less than or equal to the number of physical outputs on the router.
router_type String One of these:
  • blackmagic_videohub

  • miranda_nvision

  • harris_panacea

  • snell_aurora

level_id Integer This appears only for Harris Panacea and Miranda nVision.
user_id Integer This appears only for Miranda nVision.
matrix_id Integer This appears only for Snell Aurora.

Response

The response repeats back the data that you posted with the addition of <id>: the newly assigned ID for the router.

The response is identical to the response to a GET Router. See the following example.

Example

Request

This request creates one router with the name “SDI_Router.” This router has 12 inputs and 12 outputs, so these numbers are set in the max_inputs and max_outputs.

POST http://198.51.100.0/routers ------------------------------------------ Content-type:application/vnd.elemental+xml;version=3.3.0 Accept:application/xml ---------------------------------------- <router> <name>SDI_Router</name> <ip>192.168.10.10</ip> <router_type>blackmagic_videohub</router_type> <max_inputs>12</max_inputs> <max_outputs>12</max_outputs> </router>

Response

In this example, the router is given the ID 1.

<?xml version="1.0" encoding="UTF-8"?> <router href="/routers" product="AWS Elemental Conductor Live" version="3.3.nnnnn"> <id>1</id> <name>BlackMagic1</name> <ip>192.168.10.10</ip> <router_type>blackmagic_videohub</router_type> <max_inputs>12</max_inputs> <max_outputs>12</max_outputs> <router>