List Bridge Endpoints
Returns information about all configured bridge endoints
Request
URI
GET
https://nsxmanager.your.domain/api/v1/bridge-endpoints
COPY
Query Parameters
string
bridge_cluster_id
Optional
Bridge Cluster Identifier
string
bridge_endpoint_profile_id
Optional
Bridge endpoint profile used by the edge cluster
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
included_fields
Optional
Comma separated list of fields that should be included in query result
string
logical_switch_id
Optional
Logical Switch Identifier
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
boolean
sort_ascending
Optional
sort_ascending
string
sort_by
Optional
Field by which records are sorted
string
vlan_transport_zone_id
Optional
VLAN transport zone id used by the edge cluster
Responses
200
OK
Returns BridgeEndpointListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineBridgeEndpointListResult1
{
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"cursor": "string",
"sort_ascending": false,
"sort_by": "string",
"result_count": 0,
"results": [
{
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_revision": 0,
"_system_owned": false,
"display_name": "string",
"description": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"_create_user": "string",
"_protection": "string",
"_create_time": 0,
"_last_modified_time": 0,
"_last_modified_user": "string",
"id": "string",
"resource_type": "string",
"ha_enable": false,
"bridge_cluster_id": "string",
"vlan": 0,
"vlan_transport_zone_id": "string",
"bridge_endpoint_profile_id": "string"
}
]
}
400
Returns BadRequest of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
403
Returns Forbidden of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
404
Returns NotFound of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
412
Returns PreconditionFailed of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
500
Returns InternalServerError of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
503
Returns ServiceUnavailable of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
Network Transport Operations
POST
Create Bridge Cluster
POST
Create Bridge Endpoint
POST
Create Bridge Endpoint Profile
POST
Create Cluster Profile
POST
Create Compute Collection Transport Node Template
POST
Create Edge Cluster
POST
Create Host Switch Profile
POST
Create Network Migration Spec
POST
Create Transport Node
POST
Create Transport Zone
POST
Create Transport Zone Profile
DELETE
Delete Bridge Cluster
DELETE
Delete Bridge Endpoint
DELETE
Delete Bridge Endpoint Profile
DELETE
Delete Cluster Profile
DELETE
Delete Compute Collection Transport Node Template
DELETE
Delete Edge Cluster
DELETE
Delete Host Switch Profile
DELETE
Delete Network Migration Spec
DELETE
Delete Transport Node
DELETE
Delete Transport Zone
DELETE
Delete Transport Zone Profile
GET
Get Bridge Cluster
GET
Get Bridge Cluster Status
GET
Get Bridge Endpoint
GET
Get Bridge Endpoint Profile
GET
Get Bridge Endpoint Statistics
GET
Get Bridge Endpoint Status
GET
Get Cluster Profile
GET
Get Compute Collection Transport Node Template
GET
Get Compute Collection Transport Node Template State
GET
Get Host Switch Profile
GET
Get Network Migration Spec
GET
Get Transport Node
GET
Get Transport Node State
GET
Get Transport Zone
GET
Get Transport Zone Profile
GET
Get Transport Zone Status
GET
List Bridge Clusters
GET
List Bridge Endpoint Profiles
GET
List Bridge Endpoints
GET
List Cluster Profiles
GET
List Compute Collection Transport Node Templates
GET
List Edge Clusters
GET
List Host Switch Profiles
GET
List Neighbor Properties
GET
List Network Migration Specs
GET
List Transport Nodes
GET
List Transport Nodes By State
GET
List Transport Zone Profiles
GET
List Transport Zones
GET
Read Edge Cluster
GET
Read Neighbor Properties
POST
Replace Edge Cluster Member Transport Node Replace Transport Node
POST
Resync Transport Node Resync Host Config
PUT
Update Bridge Cluster
PUT
Update Bridge Endpoint
PUT
Update Bridge Endpoint Profile
PUT
Update Cluster Profile
PUT
Update Compute Collection Transport Node Template
PUT
Update Edge Cluster
PUT
Update Host Switch Profile
PUT
Update Network Migration Spec
PUT
Update Transport Node
POST
Update Transport Node Maintenance Mode
PUT
Update Transport Zone
PUT
Update Transport Zone Profile