Get Route Map Summaries

Get Route Map Summaries

Retrieves summaries for all the Route Maps on a given Provider Gateway.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/providerGatewayServices/routing/bgp/routeMapSummaries
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.
Responses
200

OK

Returns ProviderGatewayRouteMapSummaries of type(s) application/json;version=39.1 
{
    "values": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "bgpPermissionGroupRef": {
                "id": "urn:vcloud:bgpPermissionGroup:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "name": "string",
                "accessLevel": "string"
            },
            "matchCriteriaCount": 0
        }
    ]
}
array of values
values
Optional

A summary model object for Provider Gateway Route Map.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/providerGatewayServices/routing/bgp/routeMapSummaries?pageSize=v
Availability
Added in 38.0
On This Page
Provider Gateway Route Maps Operations
GET
Get Route Map Summaries
POST
Create Route Map
GET
Get Route Map
PUT
Update Route Map
DELETE
Delete Route Map