Management Plane API >
Security
>
Services
>
Firewall
Check if the object a member of the exclude list
Request:
Method:
POST
URI Path(s):
/api/v1/firewall/excludelist?action=check_if_exists
Request Headers:
n/a
Query Parameters:
ExcludeListRequestParams
+
ExcludeListRequestParams
(
schema
)
Name
Description
Type
Notes
deep_check
Check all parents
Deep check all parents of requested object_id if any of them is in exclude list. If found, makes requested entity as excluded.
boolean
Default: "False"
object_id
identifier of the object
string
Required
Maximum length: 64
object_type
Type of the object
Used if requested for deep_check. Type allows ability to find its association and parent entities.
ExcludeMemberType
Request Body:
n/a
Example Request:
POST https://<nsx-mgr>/api/v1/firewall/excludelist?action=check_if_exists&object_id=5091f6ac-ada1-428c-b521-630bc0d55574
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:
read
Feature:
firewall_configuration
Additional Errors:
404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable