Get Prefix List

Get Prefix List

Retrieves a specific Prefix list for a given Provider Gateway.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/providerGatewayServices/routing/bgp/prefixLists/{listId}
COPY
Path Parameters
string
externalNetworkId
Required

externalNetworkId

string
listId
Required

listId

string
externalNetworkId
Required

externalNetworkId

string
listId
Required

listId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ProviderGatewayPrefixList of type(s) application/json;version=38.1 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "prefixes": [
        {
            "network": "10.22.0.0/22",
            "greaterThanEqualTo": 0,
            "lessThanEqualTo": 0,
            "action": "string"
        }
    ],
    "bgpPermissionGroupRef": {
        "id": "urn:vcloud:bgpPermissionGroup:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "name": "string",
        "accessLevel": "string"
    },
    "version": {
        "version": 0
    }
}
string
id
Optional

The unique id of this prefix list. On updates, the id is required for the list, while for create a new id will be generated. This id is not a VCD URN.

string
name
Required

Name for the prefix list.

string
description
Optional

Description for this prefix list.

array of ProviderGatewayPrefixListEntry
prefixes
Required

List of network prefixes.

ProviderGatewayBgpPermissionGroupReference
bgpPermissionGroupRef
Optional

bgpPermissionGroupRef

ObjectVersion
version
Optional

version


Availability
Added in 38.0
On This Page
Provider Gateway Prefix List Operations
DELETE
Delete Prefix List
GET
Get Prefix List
PUT
Update Prefix List