Get Enterprise Bgp Sessions
Get BGP peering session state
The logicalId GUID for the target enterprise
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
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.
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.
Limits the maximum size of the result set.
The BGP peer type
Filter by state[is]
Filter by state[isNot]
Filter by state[in]
Filter by state[notIn]
Filter by neighborIp[is]
Filter by neighborIp[isNot]
Filter by neighborIp[isNull]
Filter by neighborIp[isNotNull]
Filter by neighborIp[startsWith]
Filter by neighborIp[notStartsWith]
Filter by neighborIp[endsWith]
Filter by neighborIp[notEndsWith]
Filter by neighborIp[contains]
Filter by neighborIp[notContains]
Filter by neighborIp[in]
Filter by neighborIp[notIn]
Request successfully processed
{
"_href": "string",
"data": [
{
"_href": "string",
"msgRcvd": 0,
"msgSent": 0,
"neighborIp": "string",
"neighborAS": 0,
"pfxRcvd": 0,
"state": "string",
"timestamp": "string",
"upDownTime": "string",
"edge": {
"_href": "string",
"activationKey": "string",
"activationKeyExpires": "string",
"activationState": "string",
"activationTime": "string",
"alertsEnabled": false,
"bastionState": "string",
"buildNumber": "string",
"created": "string",
"customInfo": "string",
"description": "string",
"deviceFamily": "string",
"deviceId": "string",
"dnsName": "string",
"edgeState": "string",
"edgeStateTime": "string",
"endpointPkiMode": "string",
"factoryBuildNumber": "string",
"factorySoftwareVersion": "string",
"platformBuildNumber": "string",
"platformFirmwareVersion": "string",
"modemBuildNumber": "string",
"modemFirmwareVersion": "string",
"lteRegion": "string",
"haLastContact": "string",
"haPreviousState": "string",
"haSerialNumber": "string",
"haState": "string",
"isLive": false,
"lastContact": "string",
"logicalId": "string",
"modelNumber": "string",
"modified": "string",
"name": "string",
"operatorAlertsEnabled": false,
"selfMacAddress": "string",
"serialNumber": "string",
"serviceState": "string",
"serviceUpSince": "string",
"softwareUpdated": "string",
"softwareVersion": "string",
"systemUpSince": "string",
"links": [
{
"_href": "string"
}
],
"site": {
"_href": "string",
"created": "string",
"name": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"shippingSameAsLocation": false,
"shippingContactName": "string",
"shippingAddress": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingState": "string",
"shippingCountry": "string",
"shippingPostalCode": "string",
"modified": "string"
},
"enterprise": {
"_href": "string",
"created": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"endpointPkiMode": "string",
"name": "string",
"domain": "string",
"prefix": "string",
"logicalId": "string",
"accountNumber": "string",
"description": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"modified": "string",
"gatewayPool": {
"_href": "string"
},
"bastionState": "string"
},
"haMode": "string",
"standbySystemUpSince": "string",
"standbyServiceUpSince": "string",
"standbySoftwareVersion": "string",
"standbyFactorySoftwareVersion": "string",
"standbyFactoryBuildNumber": "string",
"standbyBuildNumber": "string",
"standbyModelNumber": "string",
"standbyDeviceId": "string"
},
"gateway": {
"_href": "string",
"id": "number",
"created": "string",
"networkId": 0,
"enterpriseProxyId": 0,
"siteId": 0,
"activationKey": "string",
"activationState": "string",
"activationTime": "string",
"softwareVersion": "string",
"buildNumber": "string",
"utilization": "number",
"utilizationDetail": {},
"connectedEdges": 0,
"connectedEdgeList": [
{}
],
"dataCenterVpnStates": "string",
"deviceId": "string",
"logicalId": "string",
"name": "string",
"gatewayState": "string",
"alertsEnabled": false,
"description": "string",
"dnsName": "string",
"isLoadBalanced": false,
"privateIpAddress": "string",
"ipAddress": "string",
"ipV6Address": "string",
"lastContact": "string",
"systemUpSince": "string",
"serviceUpSince": "string",
"serviceState": "string",
"bastionState": "string",
"endpointPkiMode": "string",
"handOffDetail": {},
"ipsecGatewayDetail": {},
"modified": "string"
}
}
],
"metaData": {
"prevPageLink": "string",
"nextPageLink": "string",
"limit": 0,
"more": false
}
}_href
ValidationError
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string",
"errors": [
{
"message": "string",
"path": "string"
}
]
}A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Unauthorized
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Resource not found
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Rate Limit Exceeded
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Internal server error
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation