[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get Prefix List

Description

Retrieves a specific Prefix list for a given edge gateway.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/bgp/prefixLists/{listId}
Copy

Path Parameters

Path Parameters

string
gatewayId Required

string
listId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns EdgePrefixList of type(s) application/json;version=36.3
{
	"description": "string",
	"id": "string",
	"name": "string",
	"prefixes": [
		{
			"action": "PERMIT",
			"greaterThanEqualTo": 0,
			"lessThanEqualTo": 0,
			"network": "10.22.0.0/22"
		}
	],
	"version": {
		"version": 0
	}
}
string
name Required

Name for the prefix list.


prefixes Required

List of network prefixes.


string
description Optional

Description for this prefix list.


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.


version Optional

This property describes the current version of the entity. To prevent clients from overwriting each other’s changes, update operations must include the version which can be obtained by issuing a GET operation. If the version number on an update call is missing, the operation will be rejected. This is only needed on update calls.

Errors

Errors

404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/bgp/prefixLists/{listId}


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 34.0
Edge Gateway Prefix List Operations
Feedback

Was this page helpful?