List NS Groups | NSX-T Data Center REST API

List NS Groups

List the NSGroups in a paginated format. The page size is restricted to 50 NSGroups so that the size of the response remains small even in the worst case. Optionally, specify valid member types as request parameter to filter NSGroups.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/ns-groups

COPY

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

included_fields

Optional

Comma separated list of fields that should be included in query result

string

member_types

Optional

Specify member types to filter corresponding NSGroups

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

boolean

populate_references

Optional

Populate metadata of resource referenced by NSGroupExpressions

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns NSGroupListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineNSGroupListResult1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_revision": 0,
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_create_user": "string",
            "_protection": "string",
            "_create_time": 0,
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "member_count": 0,
            "members": [
                {
                    "resource_type": "string",
                    "target_resource": {
                        "target_display_name": "string",
                        "is_valid": false,
                        "target_id": "string",
                        "target_type": "string"
                    },
                    "target_property": "string",
                    "target_type": "string",
                    "value": "string",
                    "op": "string"
                }
            ],
            "membership_criteria": [
                {
                    "resource_type": "string"
                }
            ]
        }
    ]
}

400

Returns BadRequest of type(s) application/json