List Devices
GET/v2/org/:org_id/devices
Returns all devices for your organization.
Required Scope: read-devices
Overview
Use this endpoint to manage your device inventory and map Hubble-registered devices to your system. (To consume a stream of incoming data, use the Retrieve Organization Packets endpoint.)
Query Parameters
Timestamp Filters
Use timestamp filters to trim down the search results.
- For simpliticy, we support the
between:{after_timestamp}:{before_timestamp}operator. - The
after_timestampvalue is inclusive and thebefore_timestampvalue is exclusive.
Recent Packet
Each device may return a most_recent_packet object. This is a sample packet that is periodically refreshed.
- Latency: provided data is not updated in real-time or atomically with packet data.
- Availability: registered devices that have never sent a packet will have an empty
most_recent_packetfield.
This endpoint should not be used to request packet data. See "Retrieve Organization Packets".
When sorting by most_recent_packet,
- Devices that have never sent a packet are included in results and sort to the beginning (ascending) or end (descending) of the page.
- If
sort_ascendingis true, the pagination may return duplicate values since a device with a newmost_recent_packetcould be returned in subsequent pages. - If
sort_ascendingis false, the pagination may skip devices that receive newmost_recent_packetdata during the pagination.
Example Queries
- Unused devices:
filter_most_recent_packet_ts=between:0:1 - Recently Active Devices:
filter_most_recent_packet_ts=between:{timestamp_one_day_ago}:{timestamp_now} - Inactive Devices:
filter_most_recent_packet_ts=between:1:{timestamp_one_week_ago} - Recently Registered Devices:
filter_created_ts=between:{timestamp_one_day_ago}:{timestamp_now}
Request
Responses
- 200
- 400
- 500
Device Pages
Response Headers
Continuation-Token
A token to indicate how to continue paging
Bad Request
Internal Server Error