List Security Group

List Security Group

Returns a page of the SecurityGroup from the iaas provider.

Request
URI
GET
https://{api_host}/iaas-proxy-provider/api/services/{serviceId}/network/security-groups/all
COPY
Path Parameters
string
serviceId
Required

The ID of the IaaS service as registered in the Component Registry service.

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
listSecurityGroupBody of type(s) application/json
Optional
Responses
200

Successful operation.

[
    {
        "name": "string",
        "tenantId": "string",
        "description": "string",
        "externalId": "string",
        "id": "string",
        "extensionData": {
            "entries": [
                {
                    "key": "string"
                }
            ]
        },
        "internal": false,
        "ipAddressCollection": [
            "string"
        ],
        "machineIdCollection": [
            "string"
        ],
        "securityGroupTypeId": "string"
    }
]

On This Page
Security Operations
POST
Allocate Security Group
POST
Assign Machines To Security Group
POST
Assign Security Polices To Security Group
POST
Create Security Group
POST
Deallocate Component
DELETE
Delete Security Group
POST
Get Security Group Allocation Constraint
GET
Get Security Group Policy
GET
List Security Group
GET
List Security Group For Tenant
PUT
Update Security Group