id
, name
, and other fields.
id
is a common filter amongst all list endpoints. It allows you to filter by a resource’s unique identifier. For example, when listing devices, you can filter by the device id using id=<device-id>
in the request URL.
The following uses the id=dvc_123
filter to only include the device with the dvc_123
id
:
|
separated list: <filter_name>=<value_1>|<value_2>|<value_3>
.
Thus, to filter devices by multiple ids, you can use the id
filter with a |
separated list of ids: id=dvc_123|dvc_456|dvc_789
.
dvc_123
and dvc_456
and the name Robot A
: id=dvc_123|dvc_456&name=Robot%20A
.
%20
. Browsers and client applications will automatically URL encode the values for you, so you shouldn’t need to worry about it but it’s good to know.
The following request filters the device list to only include the device with the name My Device Name
using the name=My%20Device%20Name
filter.