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

REST API: GET a cable by providing termination ids and termination types #5442

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

Originally created by @rmammadli on GitHub (Sep 29, 2021).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.0.0

Feature type

Data model extension

Proposed functionality

There are currently ~ 2500 cables within our netbox instance and it is going to grow rapidly in near future.

Current version of Netbox API does not offer possibility to get / filter cable(s) using termination values (id, type).

To create / update a cable, we firstly need check if there is already cable exsiting with given data below:

  • termination_a_id
  • termination_a_type
  • termination_b_id
  • termination_b_type

For that we need execute GET request to obtain all cables from Netbox API and then execute search in obtained data additionally.

Benchmarks:

with default values for limit and offset to GET cables:

curl -s -X GET -H "Authorization: Token $TOKEN" -H "Content-Type: application/json" https://my_netbox_instance/api/dcim/cables/?limit=50&offset50

real 0m2,236s
user 0m0,000s
sys 0m0,062s

GET all cables, limit=0:

curl -s -X GET -H "Authorization: Token $TOKEN" -H "Content-Type: application/json" https://my_netbox_instance/api/dcim/cables/?limit=0

real 0m47,855s
user 0m0,015s
sys 0m0,046s

Use case

Netbox users will be able to search for certain cable with using parameters below:

  • termination_a_id
  • termination_a_type
  • termination_b_id
  • termination_b_type

GET request in Netbox API with these parameters should be faster in comparison with GET all cables.

Database changes

No response

External dependencies

No response

Originally created by @rmammadli on GitHub (Sep 29, 2021). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.0.0 ### Feature type Data model extension ### Proposed functionality There are currently ~ 2500 cables within our netbox instance and it is going to grow rapidly in near future. Current version of Netbox API does not offer possibility to get / filter cable(s) using termination values (id, type). To create / update a cable, we firstly need check if there is already cable exsiting with given data below: - termination_a_id - termination_a_type - termination_b_id - termination_b_type For that we need execute GET request to obtain all cables from Netbox API and then execute search in obtained data additionally. Benchmarks: with default values for limit and offset to GET cables: `curl -s -X GET -H "Authorization: Token $TOKEN" -H "Content-Type: application/json" https://my_netbox_instance/api/dcim/cables/?limit=50&offset50 ` real 0m2,236s user 0m0,000s sys 0m0,062s GET all cables, limit=0: `curl -s -X GET -H "Authorization: Token $TOKEN" -H "Content-Type: application/json" https://my_netbox_instance/api/dcim/cables/?limit=0 ` real 0m47,855s user 0m0,015s sys 0m0,046s ### Use case Netbox users will be able to search for certain cable with using parameters below: - termination_a_id - termination_a_type - termination_b_id - termination_b_type GET request in Netbox API with these parameters should be faster in comparison with GET all cables. ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: feature labels 2025-12-29 19:28:02 +01:00
adam closed this issue 2025-12-29 19:28:02 +01:00
adam commented 2025-12-29 19:28:03 +01:00
Author
Owner
Copy Link

@rmammadli commented on GitHub (Oct 7, 2021):

Thank you very much @jeremystretch!

@rmammadli commented on GitHub (Oct 7, 2021): Thank you very much @jeremystretch!
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#5442
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?