NSX-T Data Center REST API

BridgeEndpointRequestParameters (type)

{
  "description": "When querying for bridge endpoints on a bridge cluster, following parameters can be used: bridge_cluster_id and logical_switch_id. When querying for bridge endpoints on an edge cluster, following parameters can be used: bridge_endpoint_profile_id, vlan_transport_zone_id and logical_switch_id. When multiple parameters are provided they will be anded together. if bridge_cluster_id is used along with bridge_endpoint_profile_id or vlan_transport_zone_id an error will be thrown.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "BridgeEndpointRequestParameters", 
  "module_id": "BridgeEndpoint", 
  "properties": {
    "bridge_cluster_id": {
      "description": "If provided, only bridge endpoints associated with the given bridge cluster will be returned.", 
      "required": false, 
      "title": "Bridge Cluster Identifier", 
      "type": "string"
    }, 
    "bridge_endpoint_profile_id": {
      "description": "If provided, only bridge endpoints associated with the given bridge endpoint profile will be returned.", 
      "required": false, 
      "title": "Bridge endpoint profile used by the edge cluster", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "logical_switch_id": {
      "description": "If provided, only bridge endpoints associated with the given logical switch will be returned.", 
      "required": false, 
      "title": "Logical Switch Identifier", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "vlan_transport_zone_id": {
      "description": "If provided, only bridge endpoints associated with the given transport zone will be returned.", 
      "required": false, 
      "title": "VLAN transport zone id used by the edge cluster", 
      "type": "string"
    }
  }, 
  "title": "Bridge Endpoint request parameters", 
  "type": "object"
}