Get all L2VPN services

Get paginated list of all L2VPN services

Request:

Method:

GET

URI Path(s):

/api/v1/vpn/l2vpn/services

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/vpn/l2vpn/services

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

L2VpnServiceListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	L2VPN serivce list result	array of L2VpnService	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "cursor": "00364c87219e-7361-4fa4-9b4e-c612ed56f1fdtier-0", "result_count": 2, "results": [ { "id": "f962173f-ac03-4d08-8366-56a41779f61d", "logical_router_id": "88a3c980-c433-43f7-80b8-987c8f80d9e1", "logical_tap_ip_pool" : [ "169.254.64.0/24" ], "enable_full_mesh" : true } ] }

Required Permissions:

read

Feature:

vpn

Additional Errors:

301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable