Page tree

In This Document 

Was this document useful? 
Your Rating:
1 Star2 Star3 Star4 Star5 Star
2 rates

Have a suggestion for the Armor Knowledge Base? Send a message to


This API call only applies to Armor Complete users.

The Get Firewall Group API retrieves details for a specified firewall group.   

You can use the Get Firewalls API to find the ovdcId / device ID, which will return as id.

You can use the Get Firewall Groups API to find the group ID, which will return as id

Sample request



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

API Call / URLMethod / Type

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

ParameterDescriptionFormatRequired or optionalExample
ovdcIdThe ID of the deviceIntegerRequired2
groupIdThe ID of the firewall groupIntegerRequired8

Sample return

 "id": 8,
 "deviceId": 2,
 "name": "Local IP",
 "description": "",
 "type": "group",
 "values": [
 "isReadonly": false
no content


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 value192.158.1.1