Get Permission Groups

Retrieve all the BGP Permission Groups for a Provider Gateway.

Request

URI

GET

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

COPY

Path Parameters

string

externalNetworkId

Required

externalNetworkId

Query Parameters

string

filter

Optional

Filter for a query. FIQL format.

string

sortAsc

Optional

Field to use for ascending sort

string

sortDesc

Optional

Field to use for descending sort

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

This response body class contains all of the following: InlineProviderGatewayBgpPermissionGroups0 , InlineProviderGatewayBgpPermissionGroups1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "status": "string",
            "id": "urn:vcloud:bgpPermissionGroup:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "name": "string",
            "description": "string",
            "bgpNeighborAccessLevel": "string",
            "communityListAccessLevel": "string",
            "prefixListAccessLevel": "string",
            "routeMapAccessLevel": "string",
            "bgpNeighborMemberCount": 0,
            "communityListMemberCount": 0,
            "prefixListMemberCount": 0,
            "routeMapMemberCount": 0
        }
    ]
}

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/providerGatewayServices/routing/bgp/permissionGroups?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