Skip to main content

Create a Route (v2)

Use this command to create an individual route.

Active for Version: 4.2+

Authorizations: Administrator, Operator

Requests

CODE
POST /api/routes
cookie: sessionID: [Session ID]

{ 
  "name": "[Route name]",
  "sourceId": "[Source ID]",
  "destinationIds": [<Destination ID list>],
  "tags": [<Tags list>]
}

Parameters

Name

Type

Description

name

string

Name of route.

sourceId

string

The ID of the source/input in the route.

destinationIDs

string[]

The IDs of all destinations/outputs in the route.

tags

string[]

The tag string array.

Response

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

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.