Get List of Routes

Use this command to get details of all routes. Retrieve the Device ID via the Get Device Info command.

Tip

Routes are paged and have a numPages attribute in the response. If the numPages value is greater than 1, use the page and/or pageSize parameters to access the rest of the data. For example, GET /api/.../routes?page=2&pageSize=10 fetches routes 11-20 from the collection.
You may also filter the list by labels. For example: GET /api/routes?labels=labe1,label2

Active for Version: 3.2+

Authorizations: Administrator, Operator, Observer

Requests

CODE

GET /api/gateway/[Device ID]/routes
cookie: sessionID: [Session ID]

Parameters

N/A

Response

CODE

{
  "data": { [
    <Array of Route Objects>
  ]},
  "numPages": 1,
  "numResults": 3,
  "numActiveOutputConnections": 1,
  "pendingRouteCreates": 1
}

Name	Type	Description
data	object	Data object, including route objects (see Route Object Model for definition).
numPages	number	Number of pages of routes. See the above tip on using the numPages attribute.
numResults	number	Number of available routes.
numActiveOutputConnections	number	Number of currently active outputs.
pendingRouteCreates	number	Number of routes that are pending creation, and that are not yet listed.