Expose circuit terminations in interface API serializer #1031

Closed
opened 2025-12-29 16:28:08 +01:00 by adam · 1 comment
Owner

Originally created by @jeremystretch on GitHub (Jun 14, 2017).

Issue type: Feature request

Currently, the interface API serializer includes two fields relating to connections:

  • connection: InterfaceConnection object
  • connected_interface: Peer Interface object

However, this does not communicate whether an interface is in use as a circuit termination point. This information is necessary to check whether an interface is a candidate for a new connection (see #1266).

I propose replacing the two fields above with a single connection object which will contain the relevant information for either an InterfaceConnection or a CircuitTermination, as well as a connection_type field to indicate which it is. Utilizing a single field for this information allows an API consume to simply check whether or not an interface is occupied.

Originally created by @jeremystretch on GitHub (Jun 14, 2017). ### Issue type: Feature request Currently, the interface API serializer includes two fields relating to connections: * `connection`: InterfaceConnection object * `connected_interface`: Peer Interface object However, this does not communicate whether an interface is in use as a circuit termination point. This information is necessary to check whether an interface is a candidate for a new connection (see #1266). I propose replacing the two fields above with a single `connection` object which will contain the relevant information for either an InterfaceConnection or a CircuitTermination, as well as a `connection_type` field to indicate which it is. Utilizing a single field for this information allows an API consume to simply check whether or not an interface is occupied.
adam added the type: feature label 2025-12-29 16:28:08 +01:00
adam closed this issue 2025-12-29 16:28:08 +01:00
Author
Owner

@jeremystretch commented on GitHub (Jul 10, 2017):

Implemented in 8a87d60

@jeremystretch commented on GitHub (Jul 10, 2017): Implemented in 8a87d60
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#1031