Management Plane API > Networking > VPN > IPSEC > Peer Endpoints

Edit custom IPSecPeerEndpoint

Edit custom IPSec peer endpoint. System owned endpoints are non editable.

Request:

Method:
PUT
URI Path(s):
/api/v1/vpn/ipsec/peer-endpoints/<ipsec-vpn-peer-endpoint-id>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
IPSecVPNPeerEndpoint+

Example Request:

PUT https://<nsx-mgr>/api/v1/vpn/ipsec/peer-endpoints/f0cb1b37-d618-4406-94eb-b4099418a165 { "resource_type": "IPSecVPNPeerEndpoint", "description": "Peer endpoint for plr 1", "id": "f0cb1b37-d618-4406-94eb-b4099418a165", "display_name": "Peer endpoint for plr 1", "connection_initiation_mode": "INITIATOR", "authentication_mode": "PSK", "ipsec_tunnel_profile_id": "12a3a34c-c37b-11e7-abc4-cec278b6b50a", "dpd_profile_id": "12a39f8c-c37b-11e7-abc4-cec278b6b50a", "psk": "test", "ike_profile_id": "12a3a23e-c37b-11e7-abc4-cec278b6b50a", "peer_address": "2.1.4.1", "peer_id": "2.1.4.1", "_create_time": 1517293670492, "_last_modified_user": "admin", "_last_modified_time": 1517293670492, "_system_owned": false, "_create_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 0 }

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
IPSecVPNPeerEndpoint+

Example Response:

{ "resource_type": "IPSecVPNPeerEndpoint", "description": "Peer endpoint for plr 1", "id": "f0cb1b37-d618-4406-94eb-b4099418a165", "display_name": "Peer endpoint for plr 1", "connection_initiation_mode": "INITIATOR", "authentication_mode": "PSK", "ipsec_tunnel_profile_id": "12a3a34c-c37b-11e7-abc4-cec278b6b50a", "dpd_profile_id": "12a39f8c-c37b-11e7-abc4-cec278b6b50a", "psk": "test", "ike_profile_id": "12a3a23e-c37b-11e7-abc4-cec278b6b50a", "peer_address": "2.1.4.1", "peer_id": "2.1.4.1", "_create_time": 1517293670492, "_last_modified_user": "admin", "_last_modified_time": 1667293670492, "_system_owned": false, "_create_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 1 }

Required Permissions:

crud

Feature:

vpn

Additional Errors: