Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Excerpt Include
ESLP:Complete users API (snippet)
ESLP:Complete users API (snippet)
nopaneltrue

The Update Firewall Group API updates details for a specific firewall group.   

Note

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

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

...

Sample request

Code Block
languagetext
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

Excerpt Include
ESLP:API table parts (snippet)
ESLP:API table parts (snippet)
nopaneltrue

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


Excerpt Include
ESLP:Parameters to include (snippet)
ESLP:Parameters to include (snippet)
nopaneltrue

ParameterDescriptionFormatRequired or optionalExample
deviceIdovdcId

The ID of the device

Note

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

Note
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

...

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


...