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

Return site in circuit-list API #2732

New Issue
Closed
opened 2025-12-29 18:21:32 +01:00 by adam · 2 comments
adam commented 2025-12-29 18:21:32 +01:00
Owner
Copy Link

Originally created by @tyler-8 on GitHub (Jul 9, 2019).

Environment

  • Python version: 3.6.8
  • NetBox version: 2.5.13

Proposed Functionality

Add a_site and z_site keys to output of /circuits/circuits

Use Case

In the GUI when viewing the circuit listing, the table has a column that shows the site names for each termination (if it exists). This is extremely useful for filtering by site and generally viewing the circuit list. The API for circuits does not return this matched data however. In order to get the site, you also have to call /circuits/circuit-terminations/ as well, then pair the data up. This is a slow workflow within a script, and even more-so when trying to represent the data in an external tool.

The circuit API does allow you to filter by sites so it would also make it more manageable to know which circuit belongs to which site if you're filtering on multiple sites, without having to do even more API calls.

Database Changes

N/A

External Dependencies

N/A

Originally created by @tyler-8 on GitHub (Jul 9, 2019). <!-- NOTE: This form is only for proposing specific new features or enhancements. If you have a general idea or question, please post to our mailing list instead of opening an issue: https://groups.google.com/forum/#!forum/netbox-discuss NOTE: Due to an excessive backlog of feature requests, we are not currently accepting any proposals which significantly extend NetBox's feature scope. Please describe the environment in which you are running NetBox. Be sure that you are running an unmodified instance of the latest stable release before submitting a bug report. --> ### Environment * Python version: 3.6.8<!-- Example: 3.5.4 --> * NetBox version: 2.5.13<!-- Example: 2.3.6 --> <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality Add `a_site` and `z_site` keys to output of `/circuits/circuits` <!-- Convey an example use case for your proposed feature. Write from the perspective of a NetBox user who would benefit from the proposed functionality and describe how. ---> ### Use Case In the GUI when viewing the circuit listing, the table has a column that shows the site names for each termination (if it exists). This is extremely useful for filtering by site and generally viewing the circuit list. The API for circuits does not return this matched data however. In order to get the site, you also have to call `/circuits/circuit-terminations/` as well, then pair the data up. This is a slow workflow within a script, and even more-so when trying to represent the data in an external tool. The circuit API does allow you to filter by sites so it would also make it more manageable to know which circuit belongs to which site if you're filtering on multiple sites, without having to do even more API calls. <!-- Note any changes to the database schema necessary to support the new feature. For example, does the proposal require adding a new model or field? (Not all new features require database changes.) ---> ### Database Changes N/A <!-- List any new dependencies on external libraries or services that this new feature would introduce. For example, does the proposal require the installation of a new Python package? (Not all new features introduce new dependencies.) --> ### External Dependencies N/A
adam added the status: acceptedtype: feature labels 2025-12-29 18:21:32 +01:00
adam closed this issue 2025-12-29 18:21:32 +01:00
adam commented 2025-12-29 18:21:33 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 16, 2019):

If we're going to go that route, it would probably make more sense to return the whole termination rather than just the assigned site.

@jeremystretch commented on GitHub (Jul 16, 2019): If we're going to go that route, it would probably make more sense to return the whole termination rather than just the assigned site.
adam commented 2025-12-29 18:21:33 +01:00
Author
Owner
Copy Link

@tyler-8 commented on GitHub (Jul 16, 2019):

Fair point - I'd considered that but opted for the 'lighter' output. Having the full terminations would definitely have value as well.

@tyler-8 commented on GitHub (Jul 16, 2019): Fair point - I'd considered that but opted for the 'lighter' output. Having the full terminations would definitely have value as well.
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 status: accepted type: feature
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#2732
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?