Get Enterprise BGP Sessions
DescriptionGet BGP peering session state
Request
URLURL
Path Parameters
Path Parameters
The logicalId GUID for the target enterprise
Query Parameters
Query Parameters
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
Limits the maximum size of the result set.
Filter by neighborIp[contains]
Filter by neighborIp[endsWith]
Filter by neighborIp[in]
Filter by neighborIp[isNotNull]
Filter by neighborIp[isNot]
Filter by neighborIp[isNull]
Filter by neighborIp[is]
Filter by neighborIp[notContains]
Filter by neighborIp[notEndsWith]
Filter by neighborIp[notIn]
Filter by neighborIp[notStartsWith]
Filter by neighborIp[startsWith]
A nextPageLink value, as fetched via a past call to a list API method. When a nextPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.
The BGP peer type
Possible values are: edge , gateway
A prevPageLink value, as fetched via a past call to a list API method. When a prevPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.
Filter by state[in]
Possible values are: IDLE , CONNECT , ACTIVE , OPENSENT , OPENCONFIRM , ESTABLISHED , CLEARING , IDLEADMIN , IDLEPRFXCT , REMOVED
Filter by state[isNot]
Possible values are: IDLE , CONNECT , ACTIVE , OPENSENT , OPENCONFIRM , ESTABLISHED , CLEARING , IDLEADMIN , IDLEPRFXCT , REMOVED
Filter by state[is]
Possible values are: IDLE , CONNECT , ACTIVE , OPENSENT , OPENCONFIRM , ESTABLISHED , CLEARING , IDLEADMIN , IDLEPRFXCT , REMOVED
Filter by state[notIn]
Possible values are: IDLE , CONNECT , ACTIVE , OPENSENT , OPENCONFIRM , ESTABLISHED , CLEARING , IDLEADMIN , IDLEPRFXCT , REMOVED
Response
Response BodyResponse Body
200 OK
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"
}
}
Errors
ValidationError
Unauthorized
Resource not found
Rate Limit Exceeded
Internal server error
