Interface BGPPeerings

All Known Implementing Classes:

BGPPeeringsImpl

public interface BGPPeerings

Client interface for managing BGP peering sessions on Network Edge devices. Provides operations to list, retrieve, and create BGP peering configurations for dynamic routing.

Provenance. /ne/v1/bgp* is not in the published network-edgev1 spec (1.0.0); these endpoints exist live (GET /ne/v1/bgp answered HTTP 403 for the validation account (endpoint present, permission missing) on 2026-11-11). Request and response shapes follow the earlier Network Edge API reference and may change without a spec notice.

Author:

ianjones

Method Summary

Modifier and Type	Method	Description
BGPPeeringOperator.BGPPeeringBuilder	define()	Returns an instance of BGPPeeringBuilder for defining a new BGP Peering.
BGPPeering	getByUuid(String uuid)	Gets the specified BGP Peering.
PaginatedList<BGPPeering>	list()	Lists available BGP Peerings.
PaginatedList<BGPPeering>	list(RequestBuilder.BGP requestBuilder)	Lists BGP Peerings based on the parameters provided.

Method Details

list

PaginatedList<BGPPeering> list()

Lists available BGP Peerings.

Returns:

PaginatedList

list

PaginatedList<BGPPeering> list(RequestBuilder.BGP requestBuilder)

Lists BGP Peerings based on the parameters provided.

Parameters:

requestBuilder - the desired query parameters.

Returns:

PaginatedList

getByUuid

BGPPeering getByUuid(String uuid)

Gets the specified BGP Peering.

Parameters:

uuid - the unique identifier of the BGP Peering.

Returns:

BGPPeering

define

BGPPeeringOperator.BGPPeeringBuilder define()

Returns an instance of BGPPeeringBuilder for defining a new BGP Peering.

Returns:

BGPPeeringOperator.BGPPeeringBuilder