zia_list_devices
List ZIA devices with filters for name prefix, user IDs, and pagination. Supports client-side filtering using JMESPath expressions.
Instructions
List ZIA devices with filtering by name, user, pagination support (read-only) Supports JMESPath client-side filtering via the query parameter.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Filter devices by name prefix (starts-with match). For example, 'Windows' matches 'Windows-PC-001', 'Windows-Laptop', etc. | |
| user_ids | No | Filter devices by specific user IDs. Accepts a JSON array string or Python list of user ID strings. Example: '["12345", "67890"]' or ["12345", "67890"]. Use zia_list_users to find user IDs. | |
| include_all | No | Include or exclude Cloud Browser Isolation (CBI) devices. When True, CBI devices are included in the results. Default is True. | |
| page | No | Page number for pagination (1-based). Use with page_size to retrieve large device lists in chunks. Default starts at page 1. | |
| page_size | No | Number of devices per page. Default is 100, maximum is 1000. Use smaller values for faster responses, larger for fewer API calls. | |
| query | No | JMESPath expression for client-side filtering/projection of results. | |
| service | No | The service to use. | zia |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |