Skip to main content

Update a Route (v2)

Use this command to update an individual route.

Active for Version: 4.2+

Authorizations: Administrator, Operator

Requests

CODE
POST /api/routes/[Route ID]
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 array

The ID of the source/input in the route.

destinationIds

string array

The IDs of all destinations/outputs in the route.

tags

string array

The tag string array.

Response

CODE
{
    "name": [Route Name],
    "tags": [<Tags list>],
    "state": "stopped",
    "summaryStatusCode": "unknown",
    "summaryStatusDetails": "unknown",
    "source": {<Route object>},
    "destinations": [<Destination object list>]
}

JavaScript errors detected

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

If this problem persists, please contact our support.