NSX-T Data Center REST API

Get all L2VPN sessions (Deprecated)

Get paginated list of all L2VPN sessions Deprecated:
Please use below Policy APIs.
GET /policy/api/v1/infra/tier-0s/<tier-0-id>/l2vpn-services/<service-id>/sessions
GET /policy/api/v1/infra/tier-1s/<tier-1-id>/l2vpn-services/<service-id>/sessions

Request:

Method:

GET

URI Path(s):

/api/v1/vpn/l2vpn/sessions

Request Headers:

n/a

Query Parameters:

L2VpnSessionListParameters+

L2VpnSessionListParameters (schema)

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 Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
l2vpn_service_id	Id of the L2Vpn Service If provided, only sessions associated with the given L2Vpn service will be returned	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:

L2VpnSessionListResult+

L2VpnSessionListResult (schema)

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 sessions list result	array of L2VpnSession	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:

TBD

Required Permissions:

read

Feature:

vpn

Additional Errors:

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