Skip to main content

Start or Stop Routes (v2)

Use this command to start or stop individual routes.

Active for Version: 4.2+

Authorizations: Administrator, Operator

Requests

CODE
PUT /api/routes/[Route ID]/actions
cookie: sessionID: [Session ID]

{ 
 "name": "[command]"
}

Parameters

Name

Type

Description

name

  • start

  • stop

Command to issue to the route

Response

CODE
{
    "type": "PostRouteAction",
    "message": "[Success message]"
}

Note

Status of the state property can be polled via the Get Device Configuration command. It may take several seconds to complete the command.

JavaScript errors detected

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

If this problem persists, please contact our support.