List Security Groups | vRealize Automation Notification Service API

List Security Groups

Returns a collection of security groups with specified paging, sorting and filtering parameters

Request

URI

GET

https://{api_host}/network-service//api/security-groups/all

COPY

Query Parameters

integer

page

Optional

Page Number

integer

limit

Optional

Number of entries per page

string

$orderby

Optional

Multiple comma-separated properties sorted in ascending or descending order

integer

$top

Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer

$skip

Optional

Sets how many entries you would like to skip

string

$filter

Optional

Boolean expression for whether a particular entry should be included in the response

Request Body

PageAndSortRequest4 of type(s) application/json

Optional

{
    "pageNumber": 0,
    "offset": 0,
    "pageSize": 0,
    "queryInfo": {
        "expand": [
            {
                "propertyName": "string"
            }
        ],
        "select": [
            {
                "propertyName": "string"
            }
        ],
        "top": 0,
        "skipToken": "string",
        "inlineCount": "string",
        "orderBy": [
            {
                "direction": "string"
            }
        ],
        "skip": 0,
        "rawFilter": "string",
        "rawOrderBy": "string"
    }
}

integer As int32 As int32

pageNumber

Optional

pageNumber

integer As int32 As int32

offset

Optional

offset

integer As int32 As int32

pageSize

Optional

pageSize

Sort

sort

Optional

sort

OdataQueryInfo

queryInfo

Optional

queryInfo

Responses

200

successful operation

Returns PageSecurityGroup of type(s) */*

{
    "number": 0,
    "size": 0,
    "last": false,
    "numberOfElements": 0,
    "totalPages": 0,
    "content": [
        {
            "internal": false,
            "ipAddressCollection": [
                "string"
            ],
            "machineIdCollection": [
                "string"
            ],
            "name": "string",
            "tenantId": "string",
            "securityGroupTypeId": "string",
            "description": "string",
            "externalId": "string",
            "id": "string",
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        }
    ],
    "first": false,
    "totalElements": 0
}

integer As int32 As int32

number

Optional

number

integer As int32 As int32

size

Optional

size

boolean

last

Optional

last