Get firewall profiles available.

List all the firewall profiles available by requested resource_type.

Request:

Method:

GET

URI Path(s):

/api/v1/firewall/profiles

Request Headers:

n/a

Query Parameters:

FirewallProfileListParameters+

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"
resource_type	Profile resource type Profile resource type	string	Required
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/firewall/profiles

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

FirewallProfileListResult+

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	List of the firewall profiles List of firewall profiles.	array of BaseFirewallProfile (Abstract type: pass one of the following concrete types) FirewallCpuMemThresholdsProfile FirewallDnsProfile FirewallFloodProtectionProfile FirewallSessionTimerProfile	Readonly
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": 2, "results": [ { "resource_type": "FirewallSessionTimerProfile", "id": "3f5d3a8c-8aa8-4df6-9a0f-b0456575b233", "display_name": "Firewall SessionTimer Profile 01", "tcp_first_packet": 120, "tcp_opening": 30, "tcp_established": 43200, "tcp_closing": 900, "tcp_finwait": 20, "tcp_closed": 10, "udp_first_packet": 60, "udp_single": 30, "udp_multiple": 60, "icmp_first_packet": 20, "icmp_error_reply": 10, "_last_modified_user": "admin", "_last_modified_time": 1463555187453, "_revision": 0 }, { "resource_type": "FirewallSessionTimerProfile", "id": "7e6d3a8c-8aa8-4df6-9a0f-b0456575b233", "display_name": "Firewall SessionTimer Profile 02", "tcp_first_packet": 120, "tcp_opening": 30, "tcp_established": 43200, "tcp_closing": 900, "tcp_finwait": 20, "tcp_closed": 10, "udp_first_packet": 60, "udp_single": 30, "udp_multiple": 60, "icmp_first_packet": 20, "icmp_error_reply": 10, "_last_modified_user": "admin", "_last_modified_time": 1463555187453, "_revision": 0 }, { "resource_type": "FirewallDNSProfile", "display_name": "Firewall DNS Profile 03", "dns_ttl_config": { "ttl": 86400, "ttl_type": "USE_TTL" } } ] }

Get firewall profiles available.

Request:

FirewallProfileListParameters (schema)

Example Request:

Successful Response:

FirewallProfileListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: