List All Bridge Endpoints

Returns information about all configured bridge endoints

Request:

Method:

GET

URI Path(s):

/api/v1/bridge-endpoints

Request Headers:

n/a

Query Parameters:

BridgeEndpointRequestParameters+

BridgeEndpointRequestParameters (schema)

Name	Description	Type	Notes
bridge_cluster_id	Bridge Cluster Identifier If provided, only bridge endpoints associated with the given bridge cluster will be returned.	string
bridge_endpoint_profile_id	Bridge endpoint profile used by the edge cluster If provided, only bridge endpoints associated with the given bridge endpoint profile will be returned.	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
logical_switch_id	Logical Switch Identifier If provided, only bridge endpoints associated with the given logical switch will be returned.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
vlan_transport_zone_id	VLAN transport zone id used by the edge cluster If provided, only bridge endpoints associated with the given transport zone will be returned.	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/bridge-endpoints

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

BridgeEndpointListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	BridgeEndpoint Results	array of BridgeEndpoint	Required Readonly Minimum items: 0
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count" : 3, "results" : [ { "id" : "229f1617-289d-488b-8648-17caf588fe53", "display_name" : "be2", "description" : "Bridge Endpoint 2", "resource_type" : "BridgeEndpoint", "bridge_cluster_id" : "0f473f0f-b5a3-4a97-bf0f-d855163667e1", "ha_enable" : false, "vlan" : 1, "_last_modified_time" : 1442859910756, "_create_time" : 1442859910756, "_system_owned" : false, "_create_user" : "admin", "_last_modified_user" : "admin", "_revision" : 0 }, { "id" : "3502cf40-630b-4ff6-864e-2af8acde2efd", "display_name" : "be1-updated", "description" : "Updated Bridge Endpoint 1", "resource_type" : "BridgeEndpoint", "bridge_cluster_id" : "07419c2e-3d0e-48af-b1d1-380ffb6f5943", "ha_enable" : false, "vlan" : 1, "_last_modified_time" : 1442859802286, "_create_time" : 1442859704276, "_system_owned" : false, "_create_user" : "admin", "_last_modified_user" : "admin", "_revision" : 1 } , { "id" : "3502cf40-630b-4ff6-864e-2af8acde2efd", "display_name" : "be3-edge cluster", "description" : "Bridge Endpoint 3", "resource_type" : "BridgeEndpoint", "vlan" : 1, "bridge_endpoint_profile_id" : "98a73f0f-b5a3-4a97-bf0f-d8551636654a", "vlan_transport_zone_id" : "7ac73f0f-b5a3-4a97-bf0f-d85598a9eb45", "_last_modified_time" : 1442859802286, "_create_time" : 1442859704276, "_system_owned" : false, "_create_user" : "admin", "_last_modified_user" : "admin", "_revision" : 1 }] }

List All Bridge Endpoints

Request:

BridgeEndpointRequestParameters (schema)

Example Request:

Successful Response:

BridgeEndpointListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: