Get Permission Group Members

Retrieves all the members which are assigned to the specified BGP Permission Group on a Provider Gateway. The type of the BGP member must be specified with the filter key (type==[TYPE]). Supported types are:

BGP_NEIGHBOR
COMMUNITY_LIST
PREFIX_LIST
ROUTE_MAP

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/providerGatewayServices/routing/bgp/permissionGroups/{permissionGroupId}/members

COPY

Path Parameters

string

externalNetworkId

Required

externalNetworkId

string

permissionGroupId

Required

permissionGroupId

Query Parameters

string

filter

Optional

Filter for a query. FIQL format.

integer

page

Required

Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

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 ProviderGatewayBgpPermissionGroupMembers of type(s) application/json;version=39.1

This response body class contains all of the following: InlineProviderGatewayBgpPermissionGroupMembers0 , InlineProviderGatewayBgpPermissionGroupMembers1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
            "name": "string",
            "type": "string"
        }
    ]
}

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/providerGatewayServices/routing/bgp/permissionGroups/{permissionGroupId}/members?page=value&pageSize=v

Availability

Added in 38.1

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Provider Gateway Bgp Operations

GET