Overview

The Get Firewall Groups API retrieves information about the firewall groups in your account. These groups define the individual IP addresses, IP address ranges, and subnets to be used as sources and destinations in firewall rules.

You can use this API to find the (firewall) groupID. In this API, the groupID will appear as id

You can use the Get Firewalls API to find the ovdcId / deviceId, which will appear as id.

Sample request

GET https://api.armor.com/firewall/2/groups

Input

API Call / URLMethod / Type
/firewall/{ovdcId}/groupsGET


ParameterDescriptionFormatRequired or optionalExample
ovdcId

The ID of the device to retrieve rules

You can use the Get Firewalls API to find the ovdcId / deviceId, which will appear as id.
IntegerRequired2



Sample return

StatusResponse
200
[
  {
    "id": 1,
    "deviceId": 2,
    "name": "ANY",
    "description": "The CIDR 0.0.0.0/0 represents ANY Ip, range, or CIDR.",
    "type": "any",
    "values": [
      "0.0.0.0/0"
    ],
    "isReadonly": false,
    "vcdOrgVdcId": 0
  },
  {
    "id": 2,
    "deviceId": 2,
    "name": "SSL VPN (100-127-255-192--026)",
    "description": "SSL VPN for CIDR",
    "type": "group",
    "values": [
      "100.127.255.192/26"
    ],
    "isReadonly": true,
    "vcdOrgVdcId": 0
  }
]



Output

ReturnTypeDescriptionPossible valuesExample
valuesService values

An array of ServiceValue objects:

  • protocol
  • port
Any protocol or port value0.0.0.0/0