[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform

Get Enterprise BGP Sessions

Description

Get BGP peering session state

Request

Request

URL

URL


get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/bgpSessions
Copy

Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise


Query Parameters

Query Parameters

string
include Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.


string
neighborIp[contains] Optional

Filter by neighborIp[contains]


string
neighborIp[endsWith] Optional

Filter by neighborIp[endsWith]


string
neighborIp[in] Optional

Filter by neighborIp[in]


string
neighborIp[isNotNull] Optional

Filter by neighborIp[isNotNull]


string
neighborIp[isNot] Optional

Filter by neighborIp[isNot]


string
neighborIp[isNull] Optional

Filter by neighborIp[isNull]


string
neighborIp[is] Optional

Filter by neighborIp[is]


string
neighborIp[notContains] Optional

Filter by neighborIp[notContains]


string
neighborIp[notEndsWith] Optional

Filter by neighborIp[notEndsWith]


string
neighborIp[notIn] Optional

Filter by neighborIp[notIn]


string
neighborIp[notStartsWith] Optional

Filter by neighborIp[notStartsWith]


string
neighborIp[startsWith] Optional

Filter by neighborIp[startsWith]


string
peerType Optional

The BGP peer type


string
state[in] Optional

Filter by state[in]


string
state[isNot] Optional

Filter by state[isNot]


string
state[is] Optional

Filter by state[is]


string
state[notIn] Optional

Filter by state[notIn]


Response

Response

Response Body

Response Body

200 OK returns BgpSessionCollection of type application/json

Request successfully processed

{
	"_href": "string",
	"data": [
		{
			"_href": "string",
			"edge": {
				"_href": "string",
				"activationKey": "string",
				"activationKeyExpires": "string",
				"activationState": "UNASSIGNED",
				"activationTime": "string",
				"alertsEnabled": false,
				"bastionState": "UNCONFIGURED",
				"buildNumber": "string",
				"created": "string",
				"customInfo": "string",
				"description": "string",
				"deviceFamily": "string",
				"deviceId": "string",
				"dnsName": "string",
				"edgeState": "NEVER_ACTIVATED",
				"edgeStateTime": "string",
				"endpointPkiMode": "CERTIFICATE_DISABLED",
				"enterprise": {
					"_href": "string",
					"accountNumber": "string",
					"alertsEnabled": false,
					"bastionState": "UNCONFIGURED",
					"city": "string",
					"contactEmail": "string",
					"contactMobile": "string",
					"contactName": "string",
					"contactPhone": "string",
					"country": "string",
					"created": "string",
					"description": "string",
					"domain": "string",
					"endpointPkiMode": "CERTIFICATE_DISABLED",
					"gatewayPool": {
						"_href": "string"
					},
					"lat": 0,
					"locale": "string",
					"logicalId": "string",
					"lon": 0,
					"modified": "string",
					"name": "string",
					"operatorAlertsEnabled": false,
					"postalCode": "string",
					"prefix": "string",
					"state": "string",
					"streetAddress": "string",
					"streetAddress2": "string",
					"timezone": "string"
				},
				"factoryBuildNumber": "string",
				"factorySoftwareVersion": "string",
				"haLastContact": "string",
				"haPreviousState": "UNCONFIGURED",
				"haSerialNumber": "string",
				"haState": "UNCONFIGURED",
				"isLive": false,
				"lastContact": "string",
				"links": [
					{
						"_href": "string"
					}
				],
				"logicalId": "string",
				"lteRegion": "string",
				"modelNumber": "string",
				"modemBuildNumber": "string",
				"modemFirmwareVersion": "string",
				"modified": "string",
				"name": "string",
				"operatorAlertsEnabled": false,
				"platformBuildNumber": "string",
				"platformFirmwareVersion": "string",
				"selfMacAddress": "string",
				"serialNumber": "string",
				"serviceState": "IN_SERVICE",
				"serviceUpSince": "string",
				"site": {
					"_href": "string",
					"city": "string",
					"contactEmail": "string",
					"contactMobile": "string",
					"contactName": "string",
					"contactPhone": "string",
					"country": "string",
					"created": "string",
					"lat": 0,
					"locale": "string",
					"lon": 0,
					"modified": "string",
					"name": "string",
					"postalCode": "string",
					"shippingAddress": "string",
					"shippingAddress2": "string",
					"shippingCity": "string",
					"shippingContactName": "string",
					"shippingCountry": "string",
					"shippingPostalCode": "string",
					"shippingSameAsLocation": false,
					"shippingState": "string",
					"state": "string",
					"streetAddress": "string",
					"streetAddress2": "string",
					"timezone": "string"
				},
				"softwareUpdated": "string",
				"softwareVersion": "string",
				"systemUpSince": "string"
			},
			"gateway": {
				"_href": "string",
				"ipAddress": "string",
				"ipV6Address": "string",
				"name": "string"
			},
			"msgRcvd": 0,
			"msgSent": 0,
			"neighborAS": 0,
			"neighborIp": "string",
			"pfxRcvd": 0,
			"state": "IDLE",
			"timestamp": "string",
			"upDownTime": "string"
		}
	],
	"metaData": {
		"limit": 0,
		"more": false,
		"nextPageLink": "string",
		"prevPageLink": "string"
	}
}
string
_href Optional

data Optional

Errors

Errors

400

ValidationError


401

Unauthorized


404

Resource not found


429

Rate Limit Exceeded


500

Internal server error

Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/bgpSessions


Feedback

Was this page helpful?