Netbox Get Objects
netbox_get_objectsRead-onlyIdempotent
List NetBox objects of one type, with filtering and pagination.
Instructions
List NetBox objects of one type, with filtering and pagination.
Returns 'results' plus 'total' (all matches) and 'has_more'/'next_offset'. Results are paginated - check 'has_more' before concluding. To count objects cheaply use fields=['id'] and limit=1 and read 'total'.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| omit | No | Drop these fields from the response, e.g. ['config_context', 'custom_fields']. NetBox 4.5.2+. Ignored when 'fields' is set. | |
| brief | No | Return the minimal representation (id, url, display, name). | |
| limit | No | Page size (1-1000). | |
| fields | No | Only return these fields, e.g. ['id', 'name', 'status']. ALWAYS pass this for listings - full objects cost 10x more tokens. | |
| offset | No | Number of results to skip. | |
| filters | No | NetBox filters, e.g. {'site_id': 1, 'status': 'active', 'name__ic': 'core'}. Pass a list for OR: {'id': [1, 2]}. null matches empty: {'tenant_id': None}. Lookup suffixes: n, ic, nic, isw, nisw, iew, niew, ie, nie, empty, regex, iregex, lt, lte, gt, gte. NOT supported: '__in' and multi-hop lookups like 'device__site_id' - query the related object first, then filter by its ID. | |
| ordering | No | Sort field(s); prefix with '-' for descending, e.g. 'name' or ['site', '-name']. | |
| object_type | Yes | NetBox object type as 'app.model' (e.g. 'dcim.device', 'ipam.ipaddress', 'virtualization.virtualmachine') or as an API path ('dcim/devices'). netbox_list_object_types lists every type. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||