NSX Autonomous Edge REST API

Get IPSec dead peer detection (DPD) profile list result

Get paginated list of all dead peer detection (DPD) profiles.

Request:

Method:

GET

URI Path(s):

/vpn/ipsec/dpd-profiles

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

ListRequestParameters (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	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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IPSecVPNDPDProfileListResult+

IPSecVPNDPDProfileListResult (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	Location of schema for this resource	string	Readonly
_self		SelfResourceLink	Readonly
actions	Actions applicable to the resource at this time	array of ActionDescriptor	Readonly
notify_mpa	send notification to MPA about this config change (applicable on edge node)	boolean	Default: "False"
page_cursor	Opaque cursor for next page of results, (not set on last page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	IPSec DPD Profile list results	array of IPSecVPNDPDProfile	Required

Example Response:

{ "result_count" : 1, "results" : [ { "resource_type" : "IPSecVPNDPDProfile", "id" : "12a39f8c-c37b-11e7-abc4-cec278b6b50a", "display_name" : "nsx-default-dpd-profile", "enabled" : true, "dpd_probe_interval" : 90 } ] }

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