Page tree

Overview

This API call only applies to Armor Complete users.

The Update Firewall Group API updates details for a specific 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 firewall group ID, which will return as id

Sample request

PUT https://api.armor.com/firewall/2/groups/8
{
      "id": 8,
      "deviceId": 2,
      "name": "Local IP",
      "description": "",
      "type": "group",
      "values": ["192.158.1.1"],
      "isReadonly": false
}

Input

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

API Call / URLMethod / Type
/firewall/{deviceId}/groups/{id}PUT

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

ParameterDescriptionFormatRequired or optionalExample
ovdcId

The ID of the device

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

IntegerRequired2
id

The ID of the firewall group

You can use the Get Firewall Groups API to find the firewall group ID, which will return as id
IntegerRequired8
nameThe name of the firewall groupStringRequiredLocal IP
descriptionA description for the firewall groupStringOptional""
type"group," "any"enumRequiredgroup
valuesNetwork addressesArrayRequired192.158.1.1
isReadonly

Reserved for Armor-defined groups

(You must enter false.)

BooleanRequiredfalse

Sample return

StatusResponse
200
{
  "id": 8,
  "deviceId": 2,
  "name": "Local IP",
  "description": "",
  "type": "group",
  "values": [
    "192.158.1.1"
  ],
  "isReadonly": false,
  "vcdOrgVdcId": 0
}





In this topic



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