Get Bgp Neighbors Status List

Returns the status of all the BGP neighbors configured on this Provider Gateway.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/providerGatewayServices/routing/bgp/neighbors/statuses

COPY

Path Parameters

string

externalNetworkId

Required

externalNetworkId

Query Parameters

string

cursor

Optional

Field used for getting next page of records. The value is supplied by the current result page. If not set, the first page is retrieved. If cursor is set, then all other pagination query parameters such as pageSize, sortDesc, sortAsc, queryFilter are ignored.

integer

pageSize

Required

Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns ProviderGatewayBgpNeighborsStatusList of type(s) application/json;version=39.1

{
    "values": [
        {
            "neighborId": "string",
            "edgeNodeRef": {
                "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
                "name": "string",
                "type": "string"
            },
            "sourceAddress": "string",
            "neighborAddress": "string",
            "remoteASNumber": "string",
            "connectionState": "string",
            "establishedConnectionCount": 0,
            "connectionDropCount": 0,
            "totalInPrefixCount": 0,
            "totalOutPrefixCount": 0,
            "localPort": 0,
            "remotePort": 0,
            "messagesReceived": 0,
            "messagesSent": 0,
            "timeSinceEstablished": 0,
            "announcedCapabilities": [
                "string"
            ],
            "negotiatedCapabilities": [
                "string"
            ]
        }
    ]
}

array of object

values

Optional

An object representing the status of a Provider Gateway BGP Neighbor.

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/providerGatewayServices/routing/bgp/neighbors/statuses?pageSize=v

Availability

Added in 38.1

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Provider Gateway Bgp Neighbors Operations

GET