Page tree

Overview

This API call only applies to Armor Complete users.

The Create Firewall Group API creates a firewall group.   


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



Sample request

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

{
      "name": "HTTP",
      "values": [{
                  "protocol": "tcp",
                  "port": "80"
            }
      ],
      "description": "",
      "deviceId": 2,
      "location": "DFW01"
}

Input

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

API Call / URLMethod / Type
/firewall/{deviceId}/groupsPOST

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

ParameterDescriptionFormatRequired or optionalExample
ovdcId

The ID of the device to add the firewall rules to

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

IntegerRequired2
nameThe name of the firewall groupStringRequiredHTTP
valuesArray of Service objects (protocol, port)Service []Requiredtcp, 80
descriptionDescription of the service groupStringOptional'''
locationLocation of the service groupStringRequiredDFW01

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
  }
]





In this topic



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.