Page tree

Overview

This API call only applies to Armor Complete users.

The Get Firewall Services API retrieves information about the firewall services in your account. These services define the ports and protocols that are used as service groups in firewall rules, which help configure the type of traffic being allowed or blocked.   

You can use this API to find the servicesGroup (id).

You can use the Get Firewalls API to find the device ID. 

Sample request

GET https://api.armor.com/firewall/2/services

Input

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

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

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

ParameterDescriptionFormatRequired or optionalExample
deviceIdThe ID of the deviceIntegerRequired2

Sample return

StatusResponse
200
[
 {
   "id": 4,
   "deviceId": 2,
   "location": "DFW01",
   "accountId": 0,
   "name": "HTTP",
   "description": "",
   "values": [
     {
       "port": 80,
       "protocol": "tcp",
       "subprotocol": null
     }
   ]
 }
]
400
{
 "error": true,
 "message": "Failed to retrieve Device"
}



In this topic



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