Page tree


Knowledge Base


Feedback

Have a suggestion for the Armor Knowledge Base?

Send a message to
kb@armor.com.









Overview

This API call only applies to Armor Complete users.

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


The following table describes the different parts of this API call: 

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


The following table describes the parameter (or parameters) for this API call:

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


The following table describes the expected results for specific outputs that may not be clear enough within the sample output.

ReturnTypeDescriptionPossible valuesExample
valuesService values

An array of ServiceValue objects:

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