Page tree

Overview

This API call only applies to Armor Complete users.

The Create Firewall Services API creates a firewall service group.   

You can use the Get Locations API to find a location to create the firewall services. 


Sample request

POST https://api.armor.com/firewall/2/services
{
      "name": "TCP 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
{entityType}/{entityId}/notesPUT

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

ParameterDescriptionFormatRequired or optionalExample
deviceIDThe ID of the deviceIntegerRequired2
nameThe name of the service groupStringRequiredTCP HTTP
values

Array of ServiceValue objects:

  • protocol
  • port

(Protocols must be entered in lower-case letters.)

ServiceValue[]Required
descriptionDescription of the service groupStringOptional""
locationName of the locationStringRequiredDFW01

Sample return

StatusResponse
200
{
      "id": 5,
      "location": "DFW01",
      "deviceId": 2,
      "name": "TCP HTTP",
      "description": "",
      "values": [{
                  "port": 80,
                  "protocol": "tcp",
                  "subprotocol": null
            }
      ]
}
400
{
 "error": true,
 "message": "Invalid data."
}





In this topic



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