NSX-T Data Center REST API

List VPC Groups

Paginated list of VPC Groups.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/orgs/{org-id}/projects/{project-id}/vpcs/{vpc-id}/groups
Request Headers:
n/a
Query Parameters:
GroupListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-1/vpcs/vpc-1/groups

Successful Response:

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

Example Response:

{ "results": [ { "expression": [ { "scope_type": "VPC", "scope_path": "/orgs/default/projects/project-1/vpcs/vpc-1", "resource_type": "GroupScopeExpression", "id": "vpc-1", "path": "/infra/domains/default/groups/project-1/scope-association-expressions/vpc-1", "relative_path": "vpc-1", "parent_path": "/infra/domains/default/groups/project-1", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" } ], "extended_expression": [], "reference": false, "resource_type": "Group", "id": "default", "display_name": "ORG-default-PROJECT-project-1-VPC-vpc-1-default", "description": "Group to represent the VPC", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/default", "relative_path": "default", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1", "remote_path": "", "unique_id": "56c989c1-9d17-4fee-b8c4-5cc573aa7057", "realization_id": "56c989c1-9d17-4fee-b8c4-5cc573aa7057", "owner_id": "72c3b609-e8c1-4afd-996a-c62639b7c123", "origin_site_id": "72c3b609-e8c1-4afd-996a-c62639b7c123", "marked_for_delete": false, "overridden": false, "_system_owned": true, "_create_time": 1674110089695, "_create_user": "admin", "_last_modified_time": 1674110089695, "_last_modified_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 0 }, { "expression": [ { "ip_addresses": [ "172.16.10.0/24" ], "resource_type": "IPAddressExpression", "id": "98e1e659-1190-4596-aba4-ba395cc9eb24", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/default-public-ip-group/ip-address-expressions/98e1e659-1190-4596-aba4-ba395cc9eb24", "relative_path": "98e1e659-1190-4596-aba4-ba395cc9eb24", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/default-public-ip-group", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" } ], "extended_expression": [], "reference": false, "resource_type": "Group", "id": "default-public-ip-group", "display_name": "default-public-ip-group", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/default-public-ip-group", "relative_path": "default-public-ip-group", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1", "remote_path": "", "unique_id": "fcb440c0-4606-44a6-a6a0-6ae6aaf71bfe", "realization_id": "fcb440c0-4606-44a6-a6a0-6ae6aaf71bfe", "owner_id": "72c3b609-e8c1-4afd-996a-c62639b7c123", "origin_site_id": "72c3b609-e8c1-4afd-996a-c62639b7c123", "marked_for_delete": false, "overridden": false, "_system_owned": true, "_create_time": 1674110089665, "_create_user": "admin", "_last_modified_time": 1674110089665, "_last_modified_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 0 }, { "expression": [ { "expressions": [ { "member_type": "VirtualMachine", "key": "Name", "operator": "CONTAINS", "value": "vm_1", "resource_type": "Condition", "id": "1b654423-ebc4-4e8a-b59b-5d9728fdff72", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1/condition-expressions/1b654423-ebc4-4e8a-b59b-5d9728fdff72", "relative_path": "1b654423-ebc4-4e8a-b59b-5d9728fdff72", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "conjunction_operator": "AND", "resource_type": "ConjunctionOperator", "id": "0d1502ac-6a5a-4f96-96b1-7909cdd32723", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1/conjunction-expressions/0d1502ac-6a5a-4f96-96b1-7909cdd32723", "relative_path": "0d1502ac-6a5a-4f96-96b1-7909cdd32723", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "member_type": "VirtualMachine", "key": "Tag", "operator": "EQUALS", "scope_operator": "EQUALS", "value": "London", "resource_type": "Condition", "id": "02dc8bec-3eff-4420-b7d0-1000d9cd05ca", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1/condition-expressions/02dc8bec-3eff-4420-b7d0-1000d9cd05ca", "relative_path": "02dc8bec-3eff-4420-b7d0-1000d9cd05ca", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" } ], "resource_type": "NestedExpression", "id": "24771eae-a906-45cc-acd3-db55fb1be68f", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1/nested-expressions/24771eae-a906-45cc-acd3-db55fb1be68f", "relative_path": "24771eae-a906-45cc-acd3-db55fb1be68f", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "conjunction_operator": "OR", "resource_type": "ConjunctionOperator", "id": "f0040999-5a89-407f-8249-1b9387736f3d", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1/conjunction-expressions/f0040999-5a89-407f-8249-1b9387736f3d", "relative_path": "f0040999-5a89-407f-8249-1b9387736f3d", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "ip_addresses": [ "10.112.10.1" ], "resource_type": "IPAddressExpression", "id": "59b40c96-6e57-4dbb-a651-9747c1f3aea1", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1/ip-address-expressions/59b40c96-6e57-4dbb-a651-9747c1f3aea1", "relative_path": "59b40c96-6e57-4dbb-a651-9747c1f3aea1", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "conjunction_operator": "OR", "resource_type": "ConjunctionOperator", "id": "5d007106-177c-4d44-a2b2-16ea10ac4793", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1/conjunction-expressions/5d007106-177c-4d44-a2b2-16ea10ac4793", "relative_path": "5d007106-177c-4d44-a2b2-16ea10ac4793", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "paths": [ "/orgs/default/projects/project-1/vpcs/vpc-1/groups/default" ], "resource_type": "PathExpression", "id": "69f7658c-3242-406e-9d39-0ee087d58732", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1/path-expressions/69f7658c-3242-406e-9d39-0ee087d58732", "relative_path": "69f7658c-3242-406e-9d39-0ee087d58732", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" } ], "extended_expression": [], "reference": false, "resource_type": "Group", "id": "group-1", "display_name": "test-group-abc", "description": "Group description", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-1", "relative_path": "group-1", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1", "remote_path": "", "unique_id": "1eac0c26-91e0-4c7c-a167-8beaa81f2944", "realization_id": "1eac0c26-91e0-4c7c-a167-8beaa81f2944", "owner_id": "72c3b609-e8c1-4afd-996a-c62639b7c123", "origin_site_id": "72c3b609-e8c1-4afd-996a-c62639b7c123", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_create_time": 1674110189790, "_create_user": "admin", "_last_modified_time": 1674113039077, "_last_modified_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 1 }, { "expression": [ { "expressions": [ { "member_type": "VirtualMachine", "key": "Name", "operator": "CONTAINS", "value": "vm_1", "resource_type": "Condition", "id": "fa5c0903-6f5d-4e40-a2a0-0a6734b7916b", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2/condition-expressions/fa5c0903-6f5d-4e40-a2a0-0a6734b7916b", "relative_path": "fa5c0903-6f5d-4e40-a2a0-0a6734b7916b", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "conjunction_operator": "AND", "resource_type": "ConjunctionOperator", "id": "7d7dc9d2-7f7d-4173-949b-cf3d902ece6b", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2/conjunction-expressions/7d7dc9d2-7f7d-4173-949b-cf3d902ece6b", "relative_path": "7d7dc9d2-7f7d-4173-949b-cf3d902ece6b", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "member_type": "VirtualMachine", "key": "Tag", "operator": "EQUALS", "scope_operator": "EQUALS", "value": "London", "resource_type": "Condition", "id": "25039015-5873-463a-8262-1a21c9f52ff5", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2/condition-expressions/25039015-5873-463a-8262-1a21c9f52ff5", "relative_path": "25039015-5873-463a-8262-1a21c9f52ff5", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" } ], "resource_type": "NestedExpression", "id": "8cc28be0-c5ed-4e2d-b44e-f03c7869908b", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2/nested-expressions/8cc28be0-c5ed-4e2d-b44e-f03c7869908b", "relative_path": "8cc28be0-c5ed-4e2d-b44e-f03c7869908b", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "conjunction_operator": "OR", "resource_type": "ConjunctionOperator", "id": "dace17f5-f0a6-41f8-9b0d-fdc7d6b146ef", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2/conjunction-expressions/dace17f5-f0a6-41f8-9b0d-fdc7d6b146ef", "relative_path": "dace17f5-f0a6-41f8-9b0d-fdc7d6b146ef", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "ip_addresses": [ "10.112.10.1" ], "resource_type": "IPAddressExpression", "id": "6e39723e-c621-456d-b4a8-357dcce1e11b", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2/ip-address-expressions/6e39723e-c621-456d-b4a8-357dcce1e11b", "relative_path": "6e39723e-c621-456d-b4a8-357dcce1e11b", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "conjunction_operator": "OR", "resource_type": "ConjunctionOperator", "id": "e909ce83-d4ea-4df0-88a0-f21de607351d", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2/conjunction-expressions/e909ce83-d4ea-4df0-88a0-f21de607351d", "relative_path": "e909ce83-d4ea-4df0-88a0-f21de607351d", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" }, { "paths": [ "/orgs/default/projects/project-1/vpcs/vpc-1/groups/default" ], "resource_type": "PathExpression", "id": "860dbbba-c8de-4a6d-86f3-847abb3bfaed", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2/path-expressions/860dbbba-c8de-4a6d-86f3-847abb3bfaed", "relative_path": "860dbbba-c8de-4a6d-86f3-847abb3bfaed", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2", "remote_path": "", "marked_for_delete": false, "overridden": false, "_protection": "NOT_PROTECTED" } ], "extended_expression": [], "reference": false, "resource_type": "Group", "id": "group-2", "display_name": "test-group-abc", "description": "Group description", "path": "/orgs/default/projects/project-1/vpcs/vpc-1/groups/group-2", "relative_path": "group-2", "parent_path": "/orgs/default/projects/project-1/vpcs/vpc-1", "remote_path": "", "unique_id": "fef0e3f2-026b-4192-80e1-56877dc6451e", "realization_id": "fef0e3f2-026b-4192-80e1-56877dc6451e", "owner_id": "72c3b609-e8c1-4afd-996a-c62639b7c123", "origin_site_id": "72c3b609-e8c1-4afd-996a-c62639b7c123", "marked_for_delete": false, "overridden": false, "_system_owned": false, "_create_time": 1674113099276, "_create_user": "admin", "_last_modified_time": 1674113099276, "_last_modified_user": "admin", "_protection": "NOT_PROTECTED", "_revision": 0 } ], "result_count": 4, "sort_by": "display_name", "sort_ascending": true }

Required Permissions:

read

Feature:

policy_grouping

Additional Errors: