Versions Compared

Key

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

...

firewall module APIs are useful to create, delete and fetch the values of existing configured ringgroup. 

Enable Firewall

Enable firewall configuration to into Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "enableFirewall": {
      "message": "Firewall enable process has been completed.",
      "status": true
    }
  }
}

Disable Firewall

Disable firewall configuration to into Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "disableFirewall": {
      "message": "Firewall has been disabled",
      "status": true
    }
  }
}

Add BlacklistIP

Add ( configure ) firewall configuration to into Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "addBlackListIP": {
      "status": true,
      "message": "IP has been added to blacklist"
    }
  }
}

Delete BlacklistIP

Delete( Blacklist) firewall configuration to into Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "deleteBlackListIP": {
      "status": true,
      "message": "IP removed from blacklist"
    }
  }
}

Add an IP to White List

Add Whitelist IP configuration to into Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "addWhiteListIP": {
      "status": true,
      "message": "IP has been Whitelisted"
    }
  }
}

Update Firewall Configuration

Update firewall configuration to into Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "updateFirewallConfiguration": {
      "status": true,
      "message": "Firewall configurations have been saved successfully"
    }
  }
}

Fetch BlacklistIP

Fetch ( Blacklist) firewall configuration to into Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "fetchAllBlacklistIPs": {
      "message": "List of all blacklistedIPs",
      "status": true,
      "blacklistIps": [
        {
          "sourceIp": "100.100.101.102",
          "trusted": false
        },
        {
          "sourceIp": "100.101.101.101",
          "trusted": false
        }
      ]
    }
  }
}

Fetch All White Listed IPs

Fetch ( WhiteList) IPs firewall configuration to into Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "fetchAllWhitelistIPs": {
      "status": true,
      "message": "List of all whiltelistedIPs",
      "whitelistIps": [
        {
          "sourceIp": "100.100.100.100",
          "trusted": true
        },
        {
          "sourceIp": "100.100.100.101",
          "trusted": true
        }
      ]
    }
  }
}

Fetch Firewall Configurations

Fetch  firewall configuration from Freepbx/PBXact system.

...

Code Block
{
  "data": {
    "fetchFirewallConfiguration": {
      "status": true,
      "message": "List of firewall configurations",
      "configurations": [
        {
          "status": true,
          "responsiveFirewall": true,
          "chainSip": false,
          "pjSip": false,
          "safemode": "enabled",
          "currentJiffies": "1000",
          "enableTrustedHost": true,
          "enableResponsive": true,
          "externalSetup": true,
          "provision": false
        }
      ]
    }
  }
}

Fetch Firewall Interfaces

Fetch  firewall interfaces from Freepbx/PBXact system.

...

Code Block
{
    "data": {
        "fetchInterface": {
            "status": true,
            "message": "List of firewall interface and default zones",
            "interfaces": [
                {
                    "ints": "eth0",
                    "zone": "Internet (Default Firewall)",
                    "description": "dsfdsfds"
                }
            ]
        }
    }
}

Update Firewall Interface

Update firewall Interface into Freepbx/PBXact system.

...

Code Block
{
    "data": {
        "updateFirewallInterface": {
            "clientMutationId": "12432",
            "ints": "eth0",
            "zone": "external",
            "description": "dsfdsfds",
            "message": "Firewall Interface updated successfully"
        }
    }
}

Fetch Firewall Advance Settings

Fetch  firewall settings from Freepbx/PBXact system.

...

Code Block
{
    "data": {
        "fetchFirewallAdvanceSettings": {
            "status": true,
            "message": "List of firewall advance settings",
            "advanceSettings": {
                "safemode": "disabled",
                "lefilter": "enabled",
                "customrules": "enabled",
                "rejectpackets": "enabled",
                "id_service": "disabled",
                "id_sync_fw": "legacy",
                "import_hosts": "disabled"
            }
        }
    }
}

Update Firewall Advance Settings

Update firewall Advance Settings into Freepbx/PBXact system.

...