Get Firewall Groups

Get Firewall Groups

Get all firewall groups. Supported filters are:

  • Org Vdc Network ID (networkId==[ID]) - Returns all the firewall groups which the specified network is a member of.
  • Edge Gateway ID (edgeGatewayId==[ID]) - Returns all the firewall groups which are available to the specific edge gateway.
  • Network Provider ID (networkProviderId==[ID]) - Returns all the firewall groups which are available under a specific network provider. This filter requires system admin privilege.
  • Provider Gateway ID (providerGatewayId==[ID]) - | Returns all the firewall groups which are available to a specific Provider Gateway.
The following contexts are deprecated as of API version 38.0: Org vDC Network ID (_context==networkId), Edge Gateway ID (_context==edgeGatewayId), Network Provider ID (_context==networkProviderId)
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/firewallGroups/summaries
COPY
Query Parameters
string
filter
Optional

Filter for a query. FIQL format.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

integer
page
Required

Page to fetch, zero offset.

integer
pageSize
Required

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns FirewallGroups of type(s) application/json;version=39.0
This response body class contains all of the following: Page , InlineFirewallGroups1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "orgRef": {
                "name": "string",
                "id": "string"
            },
            "edgeGatewayRef": {
                "name": "string",
                "id": "string"
            },
            "ownerRef": {
                "name": "string",
                "id": "string"
            },
            "networkProviderScope": "string",
            "status": {},
            "id": "string",
            "name": "string",
            "description": "string",
            "type": {},
            "typeValue": "string"
        }
    ]
}

Availability
Added in 33.0
On This Page
Firewall Groups Operations
POST
Create Firewall Group
GET
Get Firewall Groups