Route Object Model (v2)
The route object model differs when used in API requests and responses.
POST API Requests
Use the following route model when issuing the Create a Route (v2) and Update a Route (v2) API requests.
Name | Type | Description |
|---|---|---|
name | string | Name of route. |
id | string | Optional when creating source, required when updating. Route ID. |
sourceId | string[] | The ID of the source in the route. |
destinationIds | string[] | The ID of all destinations in the route. |
tags | string[] | Route tags array. |
GET API Responses
The following route model is returned after issuing theGet Device Configuration, Get List of Routes (v2), andGet Route Configuration (v2) API commands.
Name | Type | Description |
|---|---|---|
name | string | Name of route. |
createdAt | number | Date route created in Unix time. |
lastUpdateAt | number | Date route last updated in Unix time. |
id | string | Route ID. |
tags | string[] | Route tags array. |
source | object | Route source object. See Source Object Model for definition. |
destinations | object list | Route destinations list. See Destinations Object Model for definition. |
elapsedTime | string | Elapsed running time of route. |
state | string | Route state: stopped or running. |
pendingUpdates | object | Route update object that lists the values that are pending an update. Only appears while a route update or a stop/start action is occurring. |
summaryStatusCode | string | Route status summary code: warn, error, ok, or unknown. |
summaryStatusDetails | string | Route status details. |