starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Expose 'Related Devices' pane present in the WebUI to the API #1281

New Issue
Closed
opened 2025-12-29 16:31:02 +01:00 by adam · 1 comment
adam commented 2025-12-29 16:31:02 +01:00
Owner
Copy Link

Originally created by @bdlamprecht on GitHub (Oct 5, 2017).

Issue type

[X] Feature request

Environment

  • NetBox version: v2.1.5

Description

Currently, when looking in the WebUI for a individual device, there is a pane listing Related Devices. I'd like to know what would be required to make that list available via the RestAPI.

What I'm trying to do (that this feature would allow me to) is to easily automate the configuration for pairs of devices, such as Core-A would be paired with Core-B (such as when I query the API for the A device, I would be able to know what its "partner" device is (via id).

Originally created by @bdlamprecht on GitHub (Oct 5, 2017). ### Issue type [X] Feature request <!-- Requesting the implementation of a new feature --> ### Environment * NetBox version: v2.1.5 ### Description Currently, when looking in the WebUI for a individual `device`, there is a pane listing **Related Devices**. I'd like to know what would be required to make that `list` available via the RestAPI. What I'm trying to do (that this feature would allow me to) is to _easily_ automate the configuration for pairs of devices, such as `Core-A` would be paired with `Core-B` (such as when I query the API for the `A` device, I would be able to know what its "partner" device is (via `id`).
adam closed this issue 2025-12-29 16:31:03 +01:00
adam commented 2025-12-29 16:31:03 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 6, 2017):

The list of related devices is purely a UI function. It's provided on the page as a convenience. The query for it is:

# Find up to ten devices in the same site with the same functional role for quick reference.
related_devices = Device.objects.filter(
    site=device.site, device_role=device.device_role
).exclude(
    pk=device.pk
).select_related(
    'rack', 'device_type__manufacturer'
)[:10]

To roughly replicate this with an API request:

GET /api/dcim/devices/?site={{site}}&device_role={{device_role}}&limit=10

The only odd bit would be excluding the device in question. You could just do limit=11 and pop the device if it appears in the results (or pop the eleventh device).

@jeremystretch commented on GitHub (Oct 6, 2017): The list of related devices is purely a UI function. It's provided on the page as a convenience. The query for it is: ``` # Find up to ten devices in the same site with the same functional role for quick reference. related_devices = Device.objects.filter( site=device.site, device_role=device.device_role ).exclude( pk=device.pk ).select_related( 'rack', 'device_type__manufacturer' )[:10] ``` To roughly replicate this with an API request: ``` GET /api/dcim/devices/?site={{site}}&device_role={{device_role}}&limit=10 ``` The only odd bit would be excluding the device in question. You could just do `limit=11` and pop the device if it appears in the results (or pop the eleventh device).
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#1281
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?