NSX-T Data Center REST API

List cluster security configuration

API will list all cluster-wise security configuration as per the request parameters.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/settings/security/cluster-configs
Request Headers:
n/a
Query Parameters:
ClusterSecurityConfigurationListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/settings/security/cluster-configs GET https://<policy-mgr>/policy/api/v1/infra/settings/security/cluster-configs?feature_type=DFW&enabled=true

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterSecurityConfigurationListResult+

Example Response:

For GET https://<policy-mgr>/policy/api/v1/infra/settings/security/cluster-configs { "results": [ { "cluster": { "target_id": "5c9e6be8-ef56-4987-acff-c8e29e524e5c:domain-c20" }, "features": [ { "enabled": true, "feature": "DFW" } ], "resource_type": "ClusterSecurityConfiguration", "id": "5c9e6be8-ef56-4987-acff-c8e29e524e5c:domain-c20", "display_name": "5c9e6be8-ef56-4987-acff-c8e29e524e5c:domain-c20", "path": "/infra/settings/security/cluster-configs/5c9e6be8-ef56-4987-acff-c8e29e524e5c:domain-c20", "relative_path": "5c9e6be8-ef56-4987-acff-c8e29e524e5c:domain-c20", "parent_path": "/infra", "remote_path": "", "unique_id": "7a31a3b7-69ea-4814-81ea-8f8001e5459e", "realization_id": "7a31a3b7-69ea-4814-81ea-8f8001e5459e", "owner_id": "84711afb-13a6-4edf-a7fe-07684569a61a", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_protection": "NOT_PROTECTED", "_create_time": 1726801589279, "_create_user": "admin", "_last_modified_time": 1728470735833, "_last_modified_user": "admin", "_revision": 8 }, { "cluster": { "target_id": "a0a0ffdd-5a73-4c5a-a410-72d248c9aaa6:domain-c41" }, "features": [ { "enabled": false, "feature": "DFW" } ], "resource_type": "ClusterSecurityConfiguration", "id": "a0a0ffdd-5a73-4c5a-a410-72d248c9aaa6:domain-c41", "display_name": "a0a0ffdd-5a73-4c5a-a410-72d248c9aaa6:domain-c41", "path": "/infra/settings/security/cluster-configs/a0a0ffdd-5a73-4c5a-a410-72d248c9aaa6:domain-c41", "relative_path": "a0a0ffdd-5a73-4c5a-a410-72d248c9aaa6:domain-c41", "parent_path": "/infra", "remote_path": "", "unique_id": "501498f4-6ef4-470a-a406-8688edcc4c95", "realization_id": "501498f4-6ef4-470a-a406-8688edcc4c95", "owner_id": "84711afb-13a6-4edf-a7fe-07684569a61a", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_protection": "NOT_PROTECTED", "_create_time": 1728472162509, "_create_user": "system", "_last_modified_time": 1728472162509, "_last_modified_user": "system", "_revision": 0 }, { "cluster": { "target_id": "f73cc7b1-aa0d-4bc2-a05e-a1c83901b0be:domain-c42" }, "features": [ { "enabled": false, "feature": "DFW" } ], "resource_type": "ClusterSecurityConfiguration", "id": "f73cc7b1-aa0d-4bc2-a05e-a1c83901b0be:domain-c42", "display_name": "f73cc7b1-aa0d-4bc2-a05e-a1c83901b0be:domain-c42", "path": "/infra/settings/security/cluster-configs/f73cc7b1-aa0d-4bc2-a05e-a1c83901b0be:domain-c42", "relative_path": "f73cc7b1-aa0d-4bc2-a05e-a1c83901b0be:domain-c42", "parent_path": "/infra", "remote_path": "", "unique_id": "a51b6379-3cd0-43f8-b29f-4fd7c4749d4a", "realization_id": "a51b6379-3cd0-43f8-b29f-4fd7c4749d4a", "owner_id": "84711afb-13a6-4edf-a7fe-07684569a61a", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_protection": "NOT_PROTECTED", "_create_time": 1728472162495, "_create_user": "system", "_last_modified_time": 1728472162495, "_last_modified_user": "system", "_revision": 0 } ], "result_count": 3, "sort_by": "display_name", "sort_ascending": true } For GET https://<policy-mgr>/policy/api/v1/infra/settings/security/cluster-configs?feature_type=DFW&enabled=true { "results": [ { "cluster": { "target_id": "5c9e6be8-ef56-4987-acff-c8e29e524e5c:domain-c20" }, "features": [ { "enabled": true, "feature": "DFW" } ], "resource_type": "ClusterSecurityConfiguration", "id": "5c9e6be8-ef56-4987-acff-c8e29e524e5c:domain-c20", "display_name": "5c9e6be8-ef56-4987-acff-c8e29e524e5c:domain-c20", "path": "/infra/settings/security/cluster-configs/5c9e6be8-ef56-4987-acff-c8e29e524e5c:domain-c20", "relative_path": "5c9e6be8-ef56-4987-acff-c8e29e524e5c:domain-c20", "parent_path": "/infra", "remote_path": "", "unique_id": "7a31a3b7-69ea-4814-81ea-8f8001e5459e", "realization_id": "7a31a3b7-69ea-4814-81ea-8f8001e5459e", "owner_id": "84711afb-13a6-4edf-a7fe-07684569a61a", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_protection": "NOT_PROTECTED", "_create_time": 1726801589279, "_create_user": "admin", "_last_modified_time": 1728472730859, "_last_modified_user": "admin", "_revision": 9 } ], "result_count": 1, "sort_by": "display_name", "sort_ascending": true }

Required Permissions:

read

Feature:

policy_dfw

Additional Errors: