Get Enterprise Bgp Sessions

Get Enterprise Bgp Sessions

Get BGP peering session state

Request
URI
GET
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/bgpSessions
COPY
Path Parameters
string
enterpriseLogicalId
Required

The logicalId GUID for the target enterprise

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
prevPageLink
Optional

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.

string
nextPageLink
Optional

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.

integer,null
limit
Optional

Limits the maximum size of the result set.

string
peerType
Optional

The BGP peer type

Possible values are : edge, gateway,
string
state[is]
Optional

Filter by state[is]

Possible values are : IDLE, CONNECT, ACTIVE, OPENSENT, OPENCONFIRM, ESTABLISHED, CLEARING, IDLEADMIN, IDLEPRFXCT, REMOVED,
string
state[isNot]
Optional

Filter by state[isNot]

Possible values are : IDLE, CONNECT, ACTIVE, OPENSENT, OPENCONFIRM, ESTABLISHED, CLEARING, IDLEADMIN, IDLEPRFXCT, REMOVED,
string
state[in]
Optional

Filter by state[in]

Possible values are : IDLE, CONNECT, ACTIVE, OPENSENT, OPENCONFIRM, ESTABLISHED, CLEARING, IDLEADMIN, IDLEPRFXCT, REMOVED,
string
state[notIn]
Optional

Filter by state[notIn]

Possible values are : IDLE, CONNECT, ACTIVE, OPENSENT, OPENCONFIRM, ESTABLISHED, CLEARING, IDLEADMIN, IDLEPRFXCT, REMOVED,
string
neighborIp[is]
Optional

Filter by neighborIp[is]

string
neighborIp[isNot]
Optional

Filter by neighborIp[isNot]

string
neighborIp[isNull]
Optional

Filter by neighborIp[isNull]

string
neighborIp[isNotNull]
Optional

Filter by neighborIp[isNotNull]

string
neighborIp[startsWith]
Optional

Filter by neighborIp[startsWith]

string
neighborIp[notStartsWith]
Optional

Filter by neighborIp[notStartsWith]

string
neighborIp[endsWith]
Optional

Filter by neighborIp[endsWith]

string
neighborIp[notEndsWith]
Optional

Filter by neighborIp[notEndsWith]

string
neighborIp[contains]
Optional

Filter by neighborIp[contains]

string
neighborIp[notContains]
Optional

Filter by neighborIp[notContains]

string
neighborIp[in]
Optional

Filter by neighborIp[in]

string
neighborIp[notIn]
Optional

Filter by neighborIp[notIn]


Responses
200

Request successfully processed

Returns BgpSessionCollection of type(s) application/json
{
    "_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
    }
}
string
_href
Optional

_href

data
Optional

data

metaData
Optional

metaData


400

ValidationError

Returns ValidationError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string",
    "errors": [
        {
            "message": "string",
            "path": "string"
        }
    ]
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation

errors
Optional

A list of property-specific errors


401

Unauthorized

Returns UnAuthorized of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


404

Resource not found

Returns ResourceNotFoundError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


429

Rate Limit Exceeded

Returns RateLimitExceededError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


500

Internal server error

Returns InternalServerError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation