Page tree




In This Document 


Was this document useful? 
Your Rating:
Results:
1 Star2 Star3 Star4 Star5 Star
2 rates


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



Overview

This API call only applies to Armor Complete users.

The Get Firewall Rules retrieves the firewall rules for a specified virtual machine.

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

Sample request

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

Input

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

API Call / URLMethod / Type
/firewall/{ovdcId}/rulesGET

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 / deviceId, which will return as id.
IntegerRequired2

Sample return

StatusResponse
200
{
  "id": 1,
  "deviceId": 2,
  "accountId": 2,
  "rules": [
    {
      "id": 1,
      "destinations": [
        {
          "type": "any",
          "id": 1,
          "name": "ANY"
        }
      ],
      "sources": [
        {
          "type": "any",
          "id": 1,
          "name": "ANY"
        }
      ],
      "services": [
        {
          "id": 1,
          "deviceId": 2,
          "location": null,
          "accountId": 2,
          "name": "HTTP",
          "description": null,
          "values": [
            {
              "port": 80,
              "protocol": "tcp",
              "subprotocol": null
            }
          ],
          "vcdOrgVdcId": 0,
          "ruleId": 0
        }
      ],
      "action": "allow",
      "name": "VMA Web Traffic",
      "description": null,
      "sortOrder": 1,
      "isEnabled": true
    }
  ],
  "batchId": "00000000-0000-0000-0000-000000000000",
  "staged": true,
  "lastModified": "2015-12-13T02:31:33.53",
  "status": null,
  "vcdOrgVdcId": 0
}