NSX-T Data Center REST API

Create custom local endpoint (Deprecated)

Create custom IPSec local endpoint. Deprecated:
Please use below Policy APIs.
PATCH /policy/api/v1/infra/tier-0s/<tier-0-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>
PATCH /policy/api/v1/infra/tier-1s/<tier-1-id>/ipsec-vpn-services/<service-id>/local-endpoints/<local-endpoint-id>

Request:

Method:

POST

URI Path(s):

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

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

IPSecVPNLocalEndpoint+

IPSecVPNLocalEndpoint (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
certificate_id	Certificate Id Site certificate identifier.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ipsec_vpn_service_id	VPN Service id VPN Service id.	ResourceReference	Required
local_address	IP Address for local endpoint IPv4 or IPv6 Address for local endpoint.	IPAddress	Required
local_id	Local identifier Local identifier.	string
resource_type	Must be set to the value IPSecVPNLocalEndpoint	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
trust_ca_ids	Certificate authority (CA) identifiers Certificate authority (CA) identifier list to verify peer certificates.	array of string
trust_crl_ids	Certificate revocation list (CRL) Identifiers Certificate revocation list (CRL) identifier list of peer certificates.	array of string

Example Request:

POST https://<nsx-mgr>/api/v1/vpn/ipsec/local-endpoints { "resource_type": "IPSecVPNLocalEndpoint", "description": "Local endpoint plr1", "display_name": "Local endpoint plr1", "local_id": "40.40.40.1", "ipsec_vpn_service_id": { "target_id": "f770a847-a6c9-4bc0-94cb-1dd1d5ae622a" }, "local_address": "40.40.40.1", "trust_ca_ids": [], "trust_crl_ids": [] }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

IPSecVPNLocalEndpoint+

IPSecVPNLocalEndpoint (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
certificate_id	Certificate Id Site certificate identifier.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ipsec_vpn_service_id	VPN Service id VPN Service id.	ResourceReference	Required
local_address	IP Address for local endpoint IPv4 or IPv6 Address for local endpoint.	IPAddress	Required
local_id	Local identifier Local identifier.	string
resource_type	Must be set to the value IPSecVPNLocalEndpoint	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
trust_ca_ids	Certificate authority (CA) identifiers Certificate authority (CA) identifier list to verify peer certificates.	array of string
trust_crl_ids	Certificate revocation list (CRL) Identifiers Certificate revocation list (CRL) identifier list of peer certificates.	array of string

Example Response:

{ "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 }

Required Permissions:

crud

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