The following examples are not an exhaustive list of all possible filtering options.
Examples:
Return devices with where a property equals a value.
<property> eq <value>
filter=serialNumber eq 'STIAPL6404'
Return devices where a property does not equal a value
not <property> eq <value>
filter=not serialNumber eq 'STIAPL6404'
Return devices with where a property greater or equal a value.
<property> ge <value>
filter=createdAt ge ''2024-01-18T19:53:51.480Z''
Return devices with where a property lesser or equal a value.
<property> ge <value>
filter=updatedAt le '2024-02-18T19:53:51.480Z'
Return devices where property is populated and property contains value.
<property> eq <value> and <property> eq <value>
filter=deviceType eq 'STORAGE' and partNumber eq 'RTICXL6413'
Return devices where property is populated and property contains value.
<property> eq <value> or <property> eq <value>
filter=serialNumber eq 'STIAPL6404' or partNumber eq 'RTICXL6413'
Return devices where property is one of multiple values.
<property> in <value>,<value>
filter=deviceType in 'COMPUTE', 'STORAGE'
filter-tags
string
Filter expressions consisting of simple comparison operations joined
by logical operators to be applied on the assigned tags or their
values.
CLASS
EXAMPLES
Types
string
Comparison
eq, ne, in
Logical Expressions
and, or, not
Examples:
Return devices with where a tag key equal a tag value.
<tagKey> eq <tagValue>
filter-tags='city' eq 'London'
Return devices with where a tag key does not equal a tag value.
not <property> eq <value>
filter-tags=not 'city' eq 'Tokyo'
Return devices containing the tag key and the corresponding value.
<property> eq <value> and <property> eq <value>
filter-tags='city' eq 'London' and 'street' eq 'Piccadilly'
Return devices containing the tag key and the corresponding value.
<property> eq <value> or <property> eq <value>
filter-tags='street' eq 'Oxford Street' or 'street' eq 'Piccadilly'
Return devices containing the tag key and at least one of the specified values.
<property> in <value>,<value>
filter-tags='street' in 'Regent Street', 'Oxford Street', 'Piccadilly'
limit
integer <int64> [ 1 .. 2000 ]
Default: 2000
Specifies the number of results to be returned. The default value is 2000.
offset
integer <int64>
Default: 0
Specifies the zero-based resource offset to start the response from. The default value is 0.
select
Array of strings unique
A comma separated list of select properties to display in the response. The default is that all properties are returned.
Example: select=serialNumber,macAddress
sort
string
A comma separated list of sort expressions. A sort expression is a property name optionally followed by a direction indicator 'asc' or 'desc'. The default is ascending order.