Get IPSec local endpoint list result

Get paginated list of all local endpoints.

Request:

Method:

GET

URI Path(s):

/api/v1/vpn/ipsec/local-endpoints

Request Headers:

n/a

Query Parameters:

IPSecVPNLocalEndpointListParameters+

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
ipsec_vpn_service_id	Id of the IPSec VPN service All the local endpoints configured with the specified VPN Service id will be included in the result.	string
logical_router_id	Id of logical router All the local endpoints belonging to the specified logical router id will be included in the 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/ipsec/local-endpoints

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IPSecVPNLocalEndpointListResult+

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	IPSec local endpoint list results	array of IPSecVPNLocalEndpoint	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:

{ "result_count" : 1, "results" : [ { "resource_type" : "IPSecVPNLocalEndpoint", "description" : "Local endpoint plr1", "id" : "c99d8ed0-195b-46b0-8474-664b55cfb176", "display_name" : "Local endpoint plr1", "local_id" : "40.40.40.1", "ipsec_vpn_service_id" : { "target_display_name" : "IPSec VPN serviceplr1", "is_valid" : true, "target_type" : "IPSecVPNService", "target_id" : "f770a847-a6c9-4bc0-94cb-1dd1d5ae622a" }, "local_address" : "40.40.40.1", "trust_ca_ids" : [ ], "trust_crl_ids" : [ ], "_create_time" : 1517293221251, "_last_modified_user" : "admin", "_last_modified_time" : 1517293221251, "_system_owned" : false, "_create_user" : "admin", "_protection" : "NOT_PROTECTED", "_revision" : 0 } ] }

Get IPSec local endpoint list result

Request:

IPSecVPNLocalEndpointListParameters (schema)

Example Request:

Successful Response:

IPSecVPNLocalEndpointListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: