Searching by Attributes¶
Use device attributes to filter and find devices in your fleet. Both the web UI and the REST API support attribute-based search.
Searching by custom attributes in the UI¶
- Navigate to the Devices page.
- Open the search dropdown and select Custom attribute.
- Enter your search in
key=valueformat.
Examples:
| Input | Matches |
|---|---|
env=production | Devices where env equals production |
env | Devices that have the env attribute set (any value) |
Applying multiple filters¶
You can add multiple custom attribute filters simultaneously. Each filter narrows the results further. Devices must match all applied filters (AND logic).
For example, applying both env=production and region=eu-west returns only devices that have both attributes set to those values.
To add another filter, select Custom attribute from the dropdown again and enter the next key=value pair.
Searching by legacy attributes¶
Legacy attributes each have a dedicated filter option in the search dropdown:
| Filter | Match type | Example |
|---|---|---|
| Description | Partial (substring) | warehouse matches "Edge gateway in warehouse B" |
| Country | Exact | DE |
| City | Exact | Berlin |
| ZIP | Exact | 10115 |
| Address | Exact | Unter den Linden 1 |
Select the relevant filter from the dropdown and enter your search value.
Searching via API¶
Filter devices by custom attributes using the inventory search endpoint. Include a custom_attributes array in your search request:
curl -s -X POST \
-H "Authorization: Bearer ${QBEE_API_TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"custom_attributes": [
{"key": "env", "value": "production"},
{"key": "region", "value": "eu-west"}
]
}' \
"https://www.app.qbee.io/api/v2/inventory"
Each filter object requires a key field. The value field is optional. Omitting it matches any device that has the specified key set, regardless of its value:
curl -s -X POST \
-H "Authorization: Bearer ${QBEE_API_TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"custom_attributes": [
{"key": "env"}
]
}' \
"https://www.app.qbee.io/api/v2/inventory"
This returns all devices that have an env attribute, regardless of its value.
Sharing searches via URL¶
Attribute filters are encoded in the page URL as query parameters. This allows you to bookmark filtered views or share them with team members. For example:
https://www.app.qbee.io/#/devices?currentSearch.custom_attribute=env%3Dproduction
Copy the URL from your browser's address bar to share the filtered device view with colleagues who have appropriate access.
What Next?¶
| I want to... | Go to |
|---|---|
| Create, update, and delete attributes via the UI and API | Managing Attributes |
| Read and set attributes from the device using qbee-agent | Device-Side Access |
| Learn more about the REST API | REST API |