Management Plane API >
Security
>
Services
>
Firewall
Add a new object in the exclude list
Request:
Method:
POST
URI Path(s):
/api/v1/firewall/excludelist?action=add_member
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
ResourceReference
+
ResourceReference
(
schema
)
Name
Description
Type
Notes
is_valid
Target validity
Will be set to false if the referenced NSX resource has been deleted.
boolean
Readonly
target_display_name
Target display name
Display name of the NSX resource.
string
Readonly
Maximum length: 255
target_id
Target ID
Identifier of the NSX resource.
string
Maximum length: 64
target_type
Target type
Type of the NSX resource.
string
Maximum length: 255
Example Request:
POST https://<nsx-mgr>/api/v1/firewall/excludelist?action=add_member { "target_id" : "5091f6ac-ada1-428c-b521-630bc0d55574", "target_type" : "LogicalSwitch" }
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ResourceReference
+
ResourceReference
(
schema
)
Name
Description
Type
Notes
is_valid
Target validity
Will be set to false if the referenced NSX resource has been deleted.
boolean
Readonly
target_display_name
Target display name
Display name of the NSX resource.
string
Readonly
Maximum length: 255
target_id
Target ID
Identifier of the NSX resource.
string
Maximum length: 64
target_type
Target type
Type of the NSX resource.
string
Maximum length: 255
Example Response:
{ "target_display_name": "app-tier-01", "is_valid": true, "target_type": "LogicalSwitch", "target_id": "5091f6ac-ada1-428c-b521-630bc0d55574" }
Required Permissions:
crud
Feature:
firewall_configuration
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable