List NS Profiles

List the NSProfiles created in a paginated format.The page size is restricted to 50 NSProfiles, so that the size of the response remains small even when there are high number of NSProfiles with multiple attributes and multiple attribute values for each attribute.

This API is deprecated. Use GET /infra/context-profiles

Request

URI

GET

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

COPY

Query Parameters

string

attribute_type

Optional

Fetch NSProfiles for the given attribute type

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

integer

page_size

Optional

Constraints: minimum: 0 maximum: 1000 default: 1000

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

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 NSProfileListResult of type(s) application/json

This response body class contains all of the following: InlineNSProfileListResult1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "is_valid": false,
            "nsprofile_attribute": [
                {
                    "attributes_data": {
                        "attribute_source": "string",
                        "datatype": "string",
                        "description": "string",
                        "key": "string",
                        "value": [
                            "string"
                        ]
                    },
                    "sub_attributes": [
                        {
                            "_links": [
                                {
                                    "action": "string",
                                    "href": "string",
                                    "rel": "string"
                                }
                            ],
                            "_schema": "string",
                            "_self": {},
                            "_revision": 0,
                            "_create_time": 0,
                            "_create_user": "string",
                            "_last_modified_time": 0,
                            "_last_modified_user": "string",
                            "_protection": "string",
                            "_system_owned": false,
                            "description": "string",
                            "display_name": "string",
                            "id": "string",
                            "resource_type": "string",
                            "tags": [
                                {
                                    "scope": "string",
                                    "tag": "string"
                                }
                            ],
                            "attribute_source": "string",
                            "datatype": "string",
                            "key": "string",
                            "value": [
                                "string"
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

400

Returns BadRequest of type(s) application/json