Live search should utilize the brief API format #2147

Closed
opened 2025-12-29 17:22:41 +01:00 by adam · 0 comments
Owner

Originally created by @jeremystretch on GitHub (Nov 27, 2018).

Environment

  • Python version: 3.5.2
  • NetBox version: 2.4.8

Steps to Reproduce

  1. Select an unoccupied interface on a device and create a connection
  2. Use the live search widget to search for a device (you don't need to select one)
  3. Inspect the HTTP request(s) made

Expected Behavior

The API response should include only a minimal representation of each matching object.

Observed Behavior

Although the live search widget populates as expected, the REST API call(s) return the full object representation, where only the display name and primary key are needed. Adding the ?brief=1 query parameter will greatly reduce the response size.

Originally created by @jeremystretch on GitHub (Nov 27, 2018). ### Environment * Python version: 3.5.2 * NetBox version: 2.4.8 ### Steps to Reproduce 1. Select an unoccupied interface on a device and create a connection 2. Use the live search widget to search for a device (you don't need to select one) 3. Inspect the HTTP request(s) made ### Expected Behavior The API response should include only a minimal representation of each matching object. ### Observed Behavior Although the live search widget populates as expected, the REST API call(s) return the full object representation, where only the display name and primary key are needed. Adding the `?brief=1` query parameter will greatly reduce the response size.
adam added the type: bugstatus: accepted labels 2025-12-29 17:22:41 +01:00
adam closed this issue 2025-12-29 17:22:41 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#2147