List Devices
List devices on the specified project. To learn more about devices, read Device Concept.
Listing, Sorting and Filtering Devices
This endpoint returns the list of devices in the specified project.
Sorting
The results from this endpoint can be ordered using the $orderby query parameter. Specify a list of field names, separated by commas
where each one can optionally specify asc or desc.
Sorting is valid on the following fields: created, createdBy, displayName, id, labels, metadata/created, metadata/displayName, metadata/name, name, status/alarmSeverity, status/beamHA/activeControllerDeviceName, status/beamHA/roles, status/currentSoftwareVersion, status/lastContact, status/model, status/rollbackSoftwareVersion, status/serialNumber, updated, updatedBy
Filtering
There are two ways to filter the set of returned devices from this endpoint - the first is to use the $filter query parameter, the second is to use the
$label_key and $label query parameters.
The $filter query parameter allows for devices to be filtered on the basis of fields in the schema using OData query syntax.
See this document for more details on the syntax used.
Filters are valid on the following fields: created, createdBy, createdByEmail, createdByName, displayName, id, labels, metadata/created, metadata/displayName, metadata/name, name, spec/siteName, status/alarmSeverity, status/beamHA/activeControllerDeviceName, status/beamHA/roles, status/currentSoftwareVersion, status/lastContact, status/model, status/rollbackSoftwareVersion, status/serialNumber, updated, updatedBy, updatedByEmail, updatedByName
$label_key and $label are specific to querying devices based on their labels. Labels are a set of key-value pairs that can be used to identify devices with
any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of devices.
Examples:
?$top=10 - Returns only the first 10 devices from the list.
?$orderby=name desc - Sorts devices by name in descending order.
?$filter=name eq 'descriptive name' - Returns devices that match the provided name.
?$orderby=created desc - Sorts devices by creation date in descending order.
?$filter=created ge 2021-01-01T00:00:00Z - Returns devices created after January 1, 2021.
?$label=studio=paravalley - Returns devices with the label studio set to paravalley.
?$label=release-date~2023 - Returns devices with the label release-date set to a value that contains 2023.
?$label_key=studio&label_key=release-date - Returns devices with any value set for the studio label and the release-date label.
Authentication
Authorization Bearer
Bearer authentication of the form Bearer <token>, where token is your
auth token.
Path parameters
project_name string Required
Query parameters
$orderby string Optional
Specifies the key by which the result collection should be ordered.
$filter string Optional
Restricts the set of items returned.
$top string Optional
Specifies a non-negative integer
n that limits the number of items returned from a collection.
The service returns the number of available items up to but not greater than the specified value n. $skiptoken string Optional
Specifies a start offset to support paginated results.
Use
@odata.nextLink in the result object to enumerate the collection -
it will be present only if there's more than one page of entities. $label_key string Optional
Filters the set to the specified label key.
If multiple $label_keys are specified, matching items must have all labels.
$label string Optional
Filters the set to the specified label key/value pair.
Supports equality, inequality, and inexact matching. If multiple values are provided for the same key, items matching either value will be returned.
Response
200 A list of devices
@odata.nextLinkstringOptional
@odata.nextLink URL if the page length and number of items match.
Supplemental info
Show 5 propertiesHide 5 properties
countintegerRequired
Number of items returned
kindstringRequired
Type of items in the list
operationstringRequired
Operation type. Should always say 'list'
Pagination info
Show 4 propertiesHide 4 properties
endintegerRequired
Position of the last item in the list
recordsintegerRequired
Total number of items returned in the list
startintegerRequired
Position of the first item in the list
totalintegerRequired
Total number of items in the project
Project info
Show 2 propertiesHide 2 properties
idstringRequired
Project ID
namestringRequired
Project name
A list of devices.
Show 4 propertiesHide 4 properties
kindstringRequired
The kind of record.
Device metadata.
Show 10 propertiesHide 10 properties
createdstringOptionalformat: date-time
The time when the resource was created
createdBystringOptionalformat: uuid
ID of the user who created the resource
createdByEmailstringOptional
Email of the user who created the resource
displayNamestringOptional
The display name of the resource
idstringRequiredformat: uuid
The ID of the resource
labelsmap from strings to stringOptional
A dictionary of labels associated with the resource
Show value schemaHide value schema
[any key]string
namestringOptional
The name of the resource
updatedstringOptionalformat: date-time
The time when the resource was last updated
updatedBystringOptionalformat: uuid
ID of the user who last updated the resource
updatedByEmailstringOptional
Email of the user who last updated the resource
Device specification.
Show 8 propertiesHide 8 properties
autoPreloadLatestSoftwarebooleanOptionalDefaults to false
Whether the device should automatically preload the latest available software version.
The list of <glossary:network>s available to the device and, optionally, the interfaces they are connected to. Leave the available networks list empty to give the device access to all of the networks with routes to the device's <glossary:site>. Read Available networks to learn more.
Show 2 propertiesHide 2 properties
interfaceNamestringRequiredpattern: [^\s\/]{1,16}
The name of the <<glossary:device interface>> that will be connected to the network.
networkNamestringRequiredpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The name of the <glossary:network> that will be made available to this device.
desiredSoftwareVersionstringOptional<=255 characters
The desired version of software that should be running on the device.
Optional geolocation data for the device.
Show 1 propertyHide 1 property
coordinateslist of doublesRequired0-2 items
Co-ordinates that describe the geolocation (ISO 6709), an array of two floating point numbers [latitude(North - South), longitude(East - West)]. Set an empty array to clear the geolocation.
locationIdstringOptionalpattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
The location id is the identity of the actual device that will be associated with this record. This can be used instead of the
shortCode field when registering an on-prem device. The location id does not change so this can be a simpler approach for large scale system administration.preloadSoftwareVersionstringOptional<=255 characters
A version of the software that should be preloaded on the device.
shortCodestringOptional8-8 characters
The short code from a device's web user interface, used to on-board the device. The short code expires quickly, so it should be used immediately after it is generated. Read On-board fleet devices to learn more about on-boarding devices.
siteNamestringOptionalpattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$
The name of the <glossary:site> where the device is located.
Device status.
Show 16 propertiesHide 16 properties
alarmSeverityenumOptional
The most severe alarm level last reported by the device.
- 0 - Clear
- 1 - Info
- 2 - Warning
- 3 - Error
- 4 - Critical
Allowed values:01234
The a list of the <glossary:flow> names assigned to the device.
Show 1 propertyHide 1 property
namestringRequiredpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The name of a <glossary:flow> assigned to the device.
Information about the beamHA the device is connected to.
Show 4 propertiesHide 4 properties
activeControllerDeviceNamestringOptional1-64 characters
The name of the active controller device in the beamHA.
roleslist of stringsRequired0-3 items
The roles of the device in the beamHA (high availability) group.
statusstringOptional
The status of the beamHA group. Only returned for the active controller device.
unregisteredDeviceslist of stringsOptional
List of location IDs of devices that are part of the beamHA but not registered. Only returned for the active controller device.
Device capabilities based on software version and hardware.
Show 1 propertyHide 1 property
configurationBackupbooleanOptional
Whether the device supports configuration backup. Returns false for devices with beam software version older than 1.6.
currentSoftwareVersionstring or nullOptional<=255 characters
The current software version running on the device, as reported by the device.
Optional geolocation data for the device.
Show 1 propertyHide 1 property
coordinateslist of doublesRequired0-2 items
Co-ordinates that describe the geolocation (ISO 6709), an array of two floating point numbers [latitude(North - South), longitude(East - West)]. Set an empty array to clear the geolocation.
A list of the physical and virtual interfaces reported by the device. If an interface is referenced directly by a source or a destination, it may be continue to be present in the list even if the device no longer reports it. The
state field indicates if the interface is currently present on the device.Show 4 propertiesHide 4 properties
ipAddresseslist of stringsOptional
The IP address associated with this interface, if applicable.
namestringRequiredpattern: ^([^\s\/]{1,16}|[a-zA-Z][a-zA-Z0-9_]{1,255})$
The name of the interface on the device.
stateenumRequired
Whether the interface is currently present on the device. If an interface is referenced directly by a source or a destination, it may be continue to be present in the list even if the device no longer reports it.
Allowed values:NotPresentPresent
typeenumRequired
The type of the physical or virtual interface on the device (IP, SDI/ASI or RF).
Allowed values:IPSDIASIRF
lastContactstring or nullOptional
The last time the device contacted the system.
locationIdstring or nullOptionalpattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
The location id is the identity of the actual device that will be associated with this record. This can be used instead of the
shortCode field when registering an on-prem device. The location id does not change so this can be a simpler approach for large scale system administration.The preloaded software present on the device.
Show 7 propertiesHide 7 properties
downgradeCompatiblebooleanOptional
Whether switching to this release is safe from an underlying component perspective. False if this release has a lower minimum version requirement than the currently installed release. True when no suitable reference release can be found (fail open).
namestringRequired1-255 characters
The name of the preloaded software present on the device.
precentProgressintegerOptional0 to 100
Indication of coarse progress for states with a significant duration.
progressDetailsstringOptional<=255 charactersDefaults to
Additional information about states with a significant duration.
stateenumRequired
The current state of the preloaded software.
Allowed values:RequestedDownloadingDownloadedImportingPreloadFailedPreloadCancelledRemovingRemoved
upgradeCompatiblebooleanOptional
Whether the device's current software version meets the minimum version requirement for upgrading to this release. Mirrors the field on the device software list endpoint.
versionstringRequired<=255 characters
The version of the preloaded software.
rollbackSoftwareVersionstring or nullOptional<=255 characters
The rollback software version, as reported by the device.
secondsSinceLastContactinteger or nullOptional
The number of seconds since the last time the device contacted the system.
serialNumberstring or nullOptional1-255 characters
The serial number of the device, as reported by the device.
softwareNamestring or nullOptional0-255 characters
The name of the software installed on the device.
softwareUpgradeStateenumOptional
Indicates if a software upgrade is in progress or has failed.
Allowed values:IdleSwitchingSwitchFailed
urlstringOptional1-2048 characters
The URL to access the device's web interface remotely.
Errors
400 Bad Request
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
401 Unauthorized
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
403 Forbidden
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
404 Not Found
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
429 Too Many Requests
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
500 Internal Server Error
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code