​Pagination & Filtering

All endpoints that return collections of items support pagination, and some endpoints also support filtering.

Currently, the following endpoints support filtering:

• devices

​Pagination

The API supports pagination for endpoints returning collections by supplying limit and offset query parameters.

curl -X GET "https://api.securithings.com/v1/devices?limit=10&offset=0" \
     -H "Authorization: Bearer <token>"

By default, if no limit and offset are provided, the API will return the first 100 items.

​Filtering

Filtering is currently available only on the devices endpoint, where you can use query parameters to refine results by specific device attributes.

Available filters:

• status - The connectivity status of the device. Possible values are online, offline, partial or unknown.
• probe.agent, probe.deviceSource, probe.edge, probe.host, probe.app - The connectivity status of corresponding probe. Possible values are up, down, unknown or unmonitored.
• lifeCycleStatus - The life cycle stage of the device. Possible values are current_product, eol (End of Life), eos (End of Support) or unknown.
• isFirmwareVulnerable - Indicates if the device has a known firmware vulnerability. Possible values are 1 (Yes) or 0 (No).
• isFirmwareLatest - Indicates if the device is running the latest firmware version supported by the MGMT. Possible values are 1 (Yes) or 0 (No).
• isFirmwareUpgradeAvailable - Indicates if a firmware upgrade task is available for the device. Possible values are 1 (Yes) or 0 (No).

​Combining Filters

You can combine multiple filters for more complex queries. For example:

curl -X GET "https://api.securithings.com/v1/devices?status=offline&isFirmwareVulnerable=1&lifeCycleStatus=eos" \
     -H "Authorization: Bearer <token>"

This query retrieves all offline devices that are End of Support (EOS) and have known firmware vulnerabilities.

curl -X GET "https://api.securithings.com/v1/devices?probe.agent=up&probe.edge=down" \
     -H "Authorization: Bearer <token>"

This query retrieves all device with an agent probe reporting up and edge probe reporting down.