We use cookies on our website to ensure we provide you with the best experience on our website. By using our website, you agree to the use of cookies for analytics and personalized content.This website uses cookies. More Information
It seems like your browser didn't download the required fonts. Please revise your security settings and try again.
Barracuda CloudGen Firewall

Developer Documentation for the F-Series Firewall REST API

  • Last updated on

The following list shows the REST API for the Barracuda NextGen Firewall F-Series. Authorized administrators can access the REST API interface using HTTP basic authentication with the username and password. For information on how to configure authorization for REST API access, see How to Create a CC Admin to Access the REST API.

Servers

  • /rest/control/v1/servers [GET]
    Returns all configured virtual servers.

    Response

    200

    Comment JSON

    { 
      "servers": [ // List of server names
        "S1", 
        "S2" 
      ]
    }

    Response

    200

    Comment JSON

    { 
      "ips": [ // IPs assigned to this service
        {
          "ip": "127.0.0.9", // IP address
          "available": true // IP is available and reachable
        }
      ],
      "state": "ok", // State of the server
      // Possible values are:
      // * "inactive" - Inactive
      // * "ok" - OK
      // * "warning" - Warning
      // * "error" - Error
      "name": "S1", // Name of the server
      "type": "primary", // Type of the "current" server (in a HA setup)
      "otherType": "" // Type of the "other" server (in a HA setup)
    }


  • /rest/control/v1/servers/{server} [GET]
    Returns the state and configuration of the specified server:

    - Server IP address
    - State (Inactive, OK, Warning, Error)

    Response

    200

    Comment JSON

    { 
      "ips": [ // IPs assigned to this service
        {
          "ip": "127.0.0.9", // IP address
          "available": true // IP is available and reachable
        }
      ],
      "state": "ok", // State of the server
      // Possible values are:
      // * "inactive" - Inactive
      // * "ok" - OK
      // * "warning" - Warning
      // * "error" - Error
      "name": "S1", // Name of the server
      "type": "primary", // Type of the "current" server (in a HA setup)
      "otherType": "" // Type of the "other" server (in a HA setup)
    }


  • /rest/control/v1/servers/{server}/start [POST]
    Starts a service manually. If the service is not blocked, it is started automatically by the control daemon.

  • /rest/control/v1/servers/{server}/stop [POST]
    Stops a service on a specific server. If the service has not been blocked, it is started later automatically by the control daemon.

  • /rest/control/v1/servers/{server}/restart [POST]
    Restarts a service on a specific server. You might need to restart a service after making manual configuration file changes.

  • /rest/control/v1/servers/{server}/block [POST]
    Blocks a service so that it is not started automatically by the control daemon.

Server Services

  • /rest/control/v1/servers/{server}/services [GET]
    Returns all configured services running on a specific virtual server. 

    Response with ?expand=false

    200

    Comment JSON

    { 
      "services": [ // List of service names
        "NGFW", 
        "HTTP", 
        "control", 
        "restd" 
      ]
    }


    Response with ?expand=true

    200

    Comment JSON

    { 
      "services": [ // List of services
        {
          "name": "NGFW", // Name of the service
          "server": "S1", // Name of the server (not available for box services)
          "state": "up", // State of the service
          // Possible values are:
          // * "block" - Service is blocked
          // * "up" - Service is up
          // * "wild" - Service is unconfigured
          // * "down" - Service is down
          "processes": 1, // Number of processes
          "fileDescriptors": 3, // Number of open file descriptors
          "memory": 107352, // Memory usage in kB
          "moduleName": "Firewall", // Module name
          "info": "" // Additional information (if available)
        }
      ]
    }
    


  • /rest/control/v1/servers/{server}/services/{service} [GET] 
    Returns all servers and their active services on a NextGen Firewall F-Series. 

    Response

    200

    Comment JSON

    { 
      "name": "NGFW", // Name of the service
      "server": "S1", // Name of the server (not available for box services)
      "state": "up", // State of the service
      // Possible values are:
      // * "block" - Service is blocked
      // * "up" - Service is up
      // * "wild" - Service is unconfigured
      // * "down" - Service is down
      "processes": 1, // Number of processes
      "fileDescriptors": 3, // Number of open file descriptors
      "memory": 107352, // Memory usage in kB
      "moduleName": "Firewall", // Module name
      "info": "" // Additional information (if available)
    }


  • /rest/control/v1/servers/{server}/services/{service}/start [POST]
    Starts a service manually. If the service is not blocked, it is started automatically by the control daemon. 

  • /rest/control/v1/servers/{server}/services/{service}/stop [POST]
    Stops a service on a specific server. If the service has not been blocked, it is started later automatically by the control daemon.

  • /rest/control/v1/servers/{server}/services/{service}/block [POST]
    Blocks a service so that it is not started automatically by the control daemon. 

  • /rest/control/v1/servers/{server}/services/{service}/restart [POST]
    Restarts a service on a specific server. You might need to restart a service after making manual configuration file changes. 

Box Services

  • /rest/control/v1/box/services [GET]
    Returns all configured services running on a box level.

    Response with ?expand=false

    200

    Comment JSON

    { 
      "services": [ // List of service names
        "NGFW", 
        "HTTP", 
        "control", 
        "restd" 
      ]
    }


    Response with ?expand=true

    200

    Comment JSON

    { 
      "services": [ // List of services
        {
          "name": "NGFW", // Name of the service
          "server": "S1", // Name of the server (not available for box services)
          "state": "up", // State of the service
          // Possible values are:
          // * "block" - Service is blocked
          // * "up" - Service is up
          // * "wild" - Service is unconfigured
          // * "down" - Service is down
          "processes": 1, // Number of processes
          "fileDescriptors": 3, // Number of open file descriptors
          "memory": 107352, // Memory usage in kB
          "moduleName": "Firewall", // Module name
          "info": "" // Additional information (if available)
        }
      ]
    }


  • /rest/control/v1/box/services/{service} [GET]
    Returns a specific service running on a box level.

    Response

    200

    Comment JSON

    { 
      "name": "NGFW", // Name of the service
      "server": "S1", // Name of the server (not available for box services)
      "state": "up", // State of the service
      // Possible values are:
      // * "block" - Service is blocked
      // * "up" - Service is up
      // * "wild" - Service is unconfigured
      // * "down" - Service is down
      "processes": 1, // Number of processes
      "fileDescriptors": 3, // Number of open file descriptors
      "memory": 107352, // Memory usage in kB
      "moduleName": "Firewall", // Module name
      "info": "" // Additional information (if available)
    }


  • /rest/control/v1/box/services/{service}/start [POST] 
    Starts a box service. If the box service is not blocked, it is started automatically by the control daemon.

  • /rest/control/v1/box/services/{service}/stop [POST] 
    Stops a box service. If the box service has not been blocked, it is started later automatically by the control daemon.
  • /rest/control/v1/box/services/{service}/block [POST] 
    Blocks a box service so that is not started automatically by the control daemon.
  • /rest/control/v1/box/services/{service}/restart [POST] 
    Restarts a box service. You may need to restart a box service after making manual configuration file changes.

General Data

  • /rest/control/v1/box [GET]
    Returns the general box status.

    Response

    200

    Comment JSON

    { 
      "serverState": "ok", // State of servers and server services
      // Possible values are:
      // * "unknown" - Unknown
      // * "ok" - OK
      // * "warning" - Warning
      // * "error" - Error
      "procState": "ok", // State of resource usage
      // Possible values are:
      // * "unknown" - Unknown
      // * "ok" - OK
      // * "warning" - Warning
      // * "error" - Error
      "diskState": "ok", // State of disk usage
      // Possible values are:
      // * "unknown" - Unknown
      // * "ok" - OK
      // * "warning" - Warning
      // * "error" - Error
      "netState": "ok", // State of networking
      // Possible values are:
      // * "unknown" - Unknown
      // * "ok" - OK
      // * "warning" - Warning
      // * "error" - Error
      "eventState": 0, // Number of pending events
      "hasBoxAction": true, 
      "licState": "ok", // State of licenses
      // Possible values are:
      // * "unknown" - Unknown
      // * "ok" - OK
      // * "warning" - Warning
      // * "error" - Error
      "hasBoxnet": true, 
      "hasKernel": true 
    }


  • /rest/control/v1/box/info [GET]
    Returns the following general information:
    - State of virtual servers (Inactive, OK, Warning, Error)

    Response

    200

    Comment JSON

    { 
      "cpuLoad": { // System load averages
        "minute1": 0.85, // System load average of the last minute
        "minute5": 8.35, // System load average of the last 5 minutes
        "minute15": 5.48 // System load average of the last 15 minutes
      },
      "memory": { // Memory usage
        "usage": 12, // Memory usage in %
        "free": 3452, // Free memory in MB
        "total": 3965, // Total memory available in MB
        "used": 513 // Used memory in MB
      },
      "uptime": 5876, // Uptime of the box in s
      "time": "Sun May 1 00:00:00 2016", // Current time of the box
      "model": "vf1000", // Model
      "release": "GWAY-7.0.0-140", // Release name
      "serialNumber": "123456", // Serial number
      "cpuCores": 2, // Number of CPU cores
      "hostname": "box", // Hostname
      "users": 0, // Number of active users
      "appliance": "VM", // Appliance name
      "hypervisor": "VMWare" // Hypervisor name
    }


  • /rest/control/v1/box/motd [GET]
    Shows the Message Board.
  • /rest/control/v1/box/tips [GET]
    Shows the Product Tips.

    Response

    200

    Comment JSON

    { 
      "timestamp": 1461310255, // Timestamp of the product tips
      "version": "7.0.0", // Version this product tips belong to
      "content": "" // Actual content as HTML
    }


  • /rest/control/v1/box/reboot [POST]
    Reboots the NextGen Firewall F-Series subsystem (operating system) and its servers and services.
  • /rest/control/v1/box/shutdown [POST]
    Shuts down the NextGen Firewall F-Series subsystem (operating system) and its servers and services.
  • /rest/control/v1/box/restart [POST]
    Restarts the NextGen Firewall F-Series subsystem (operating system) and its servers and services.

Resource Operative Data

  • /rest/control/v1/box/disks [GET]
    Returns information about disk usage.

    Response

    200

    Comment JSON

    { 
      "disks": [ // List of mounted disks
        {
          "watermarks": { // Watermark levels
            "yellow": 30, // Yellow watermark level in %
            "red": 10 // Red watermark level in %
          },
          "mountpoint": "/", // Mountpoint the disk is mounted to
          "state": "ok", // State of the disk
          // Possible values are:
          // * "unknown" - Unknown
          // * "ok" - OK
          // * "warning" - Warning
          // * "error" - Error
          "size": 8254272, // Size of the disk in kB
          "free": 6039204, // Free space on the disk in kB
          "inodesMax": 524288, // Total number of inodes available
          "inodesFree": 487324 // Number of free inodes
        }
      ]
    }


  • /rest/control/v1/box/processes [GET]
    Returns the process list.

    Response with ?expand=false

    200

    Comment JSON

    { 
      "processes": [ // List of processes names
        "controld", 
        "restd" 
      ]
    }


    Response with ?expand=true

    200

    Comment JSON

    { 
      "processes": [ // List of processes
        {
          "sockets": { // Number of sockets in different states
            "listening": 2, // Number of listening sockets
            "established": 0, // Number of established socket connections
            "udp": 60, // Number of UDP sockets
            "synSent": 0, // Number of sockets with SYN sent
            "close": 0, // Number of sockets closing
            "lastAck": 0 // Number of sockets waiting for last ACK
          },
          "state": "ok", // State of the process
          // Possible values are:
          // * "unknown" - Unknown
          // * "ok" - OK
          // * "warning" - Warning
          // * "error" - Error
          "name": "controld", // Process name
          "procs": 8, // Number of processes
          "fileDescriptors": 46, // Number of open file descriptors
          "memory": 124121088, // Memory usage in bytes
          "memoryShared": 4362240, // Shared memory usage in bytes
          "usage": 0 // CPU usage
        }
      ]
    }


  • /rest/control/v1/box/processes/{name} [GET]
    Returns specific process details.

    Response

    200

    Comment JSON

    { 
      "listeningSockets": [ // List of listening sockets
        {
          "ip": "10.0.0.1", // IP address
          "port": 801 // Port
        }
      ],
      "establishedSockets": [ // List of established sockets
        {
          "localAddress": { // Local address
            "ip": "10.0.0.1", // IP address
            "port": 801 // Port
          },
          "remoteAddress": { // Remote address
            "ip": "10.0.0.1", // IP address
            "port": 801 // Port
          }
        }
      ],
      "udpSockets": [ // List of UDP sockets
        {
          "ip": "10.0.0.1", // IP address
          "port": 801 // Port
        }
      ],
      "processes": [ // List of process IDs
        3735, 
        3749 
      ],
      "openFiles": [ // List of open files
        "/dev/null" 
      ],
      "fileDescriptors": 59, // Number of open file descriptors
      "memory": 155541504, // Memory used (Bytes)
      "memoryShared": 4808704 // Shared memory used (Bytes)
    }
  • /rest/control/v1/box/mainboard [GET]
    Returns the mainboard information.

Network Operative Data

  • /rest/control/v1/box/net [GET]
    Returns the interfaces summary.

    Response

    200

    Comment JSON

    { 
      "devs": [ // List of network devices
        {
          "type": "eth", // Type of the network device
          // Possible values are:
          // * "unknown" - Unknown device type
          // * "eth" - Ethernet device
          // * "tr" - Token ring
          // * "lo" - Loopback device
          // * "tap" - TAP device
          // * "tun" - TUN device
          "name": "eth0", // Interface name
          "bytes": 1234, // Number of bytes transfered
          "packets": 2, // Number of packets transfered
          "errors": 0, // Number of errors
          "mac": "11:22:33:44:55:66" // MAC address
        }
      ]
    }
  • /rest/control/v1/box/net/ips [GET] 
    Returns IP address information.

    Response

    200

    Comment JSON

    { 
      "ips": [ // List of IP addresses
        {
          "network": { // Network the IP address belongs to
            "address": "10.0.0.1", // IP address
            "mask": 24 // Network mask in CIDR notation
          },
          "interfaces": [ // List of interfaces this IP is bound to
            "eth0", 
            "eth1" 
          ],
          "state": "ok", // State of the IP address
          // Possible values are:
          // * "unknown" - Unknown
          // * "ok" - OK
          // * "warning" - Warning
          // * "error" - Error
          "status": "up", // Status of the IP address
          "label": "mip0", // Label of the IP address
          "pingable": true, // Is the address pingable?
          "dup": "11:22:33:44:55:66" // MAC address of duplicate IP
        }
      ]
    }


  • /rest/control/v1/box/net/routes [GET]
    Returns the routing tables.

    Response

    200

    Comment JSON

    { 
      "tables": [ // List of routing tables
        {
          "routes": [ // List of routes
            {
              "filter": { // Network this entry applies to
                "address": "10.0.0.0", // Network address
                "mask": 24 // Network mask in CIDR notation
              },
              "state": "ok", // State of the entry
              // Possible values are:
              // * "wild" - Unconfigured
              // * "ok" - OK
              // * "warning" - Warning
              // * "error" - Error
              "status": "up", // Status of the entry
              "type": "device-boot", // Route type
              "interface": "eth0", // Interface name
              "sourceIp": "10.0.0.1", // Source IP used on this route
              "preference": 0, // Route metric
              "gatewayIp": "10.0.0.1", // IP address of default gateway
              "name": "IPAD01" // Name of the route
            }
          ],
          "name": "main", // Routing table name
          "from": "all" // Source
        }
      ]
    }


  • /rest/control/v1/box/net/interfaces [GET] 
    Returns the network interfaces.

    Response

    200

    Comment JSON

    { 
      "interfaces": [ // List of interfaces
        {
          "flags": [ // List of flags for this interface
            "UP", 
            "BROADCAST" 
          ],
          "features": [ // List of features of this interface
            "HW-CSUM", 
            "HIGH-DMA" 
          ],
          "name": "eth0", // Interface name
          "errors": 0, // Number of errors
          "bytes": 1234, // Number of bytes transfered
          "packets": 2, // Number of packets transfered
          "index": 1, // Index of the interface
          "type": "ETHER", // Type of the interface
          "mac": "11:22:33:44:55:66", // MAC address
          "mtu": 1500, // MTU size
          "broadcast": "ff:ff:ff:ff:ff:ff", // Broadcast MAC address
          "baseAddress": 0, // Base address of the device
          "irq": 0, // IRQ used by the device
          "realm": "intern", 
          "bridge": "", 
          "link": "", 
          "negotiation": "Auto", // Link speed negotiation
          "switch": "", // Switch
          "speed": 10000, // Speed of the interface in Mbps
          "duplex": "full" // Duplex state of the interface
        }
      ]
    }


  • /rest/control/v1/box/net/arps [GET]
    Returns the ARPs.

    Response

    200

    Comment JSON

    { 
      "arps": [ // List of ARP entries
        {
          "state": "ok", // State of the entry
          // Possible values are:
          // * "unknown" - Unknown
          // * "ok" - OK
          // * "warning" - Warning
          // * "error" - Error
          "ip": "10.0.0.1", // IP address
          "mac": "11:22:33:44:55:66", // MAC address
          "vendor": "VMware.-Inc.", // Vendor name
          "interface": "eth0", // Interface name
          "switch": "", // Switch
          "vlan": "", // VLAN
          "port": "", // Port
          "uplinks": "" // Uplinks
        }
      ]
    }
  • /rest/control/v1/box/net/proxyarps [GET]
    Returns the Proxy ARPs.

    Response

    200

    Comment JSON

    { 
      "proxyarps": [ // List of proxy ARPs
        {
          "state": "ok", // State of the entry
          // Possible values are:
          // * "unknown" - Unknown
          // * "ok" - OK
          // * "warning" - Warning
          // * "error" - Error
          "ip": "10.0.0.1", // IP address
          "interface": "eth0", // Interface name
          "origin": "", 
          "exclude": "", 
          "sourceRestriction": "" 
        }
      ]
    }


  • /rest/control/v1/box/net/ndcache [GET]
    Returns the IPv6 ND cache.

    Response

    200

    Comment JSON

    { 
      "entries": [ // List of cache entries
        {
          "state": "ok", // State of the entry
          // Possible values are:
          // * "unknown" - Unknown
          // * "ok" - OK
          // * "warning" - Warning
          // * "error" - Error
          "ip": "fe80::20c:1234:1234:1234", // IP address
          "mac": "11:22:33:44:55:66", // MAC address
          "vendor": "VMware.-Inc.", // Vendor name
          "interface": "eth0", // Interface name
          "switch": "", // Switch
          "vlan": "", // VLAN
          "port": "", // Port
          "uplinks": "" // Uplinks
        }
      ]
    }


  • /rest/control/v1/box/net/netstat [GET]
    Returns the network statistics.

  • /rest/control/v1/box/net/switches [GET]
    Returns information on network switches.

    Response

    200

    Comment JSON

    { 
      "switches": [ 
        {
          "ports": [ 
            {
              "clients": [ 
                {
                  "ips": [ 
                    {
                      "ip": "", 
                      "age": 1, 
                      "interface": "" 
                    }
                  ],
                  "mac": "", 
                  "age": 1, 
                  "type": 1 
                }
              ],
              "name": "", 
              "state": "up", 
              // Possible values are:
              // * "up"
              // * "down"
              "vlan": 1 
            }
          ],
          "name": "" 
        }
      ]
    }


  • /rest/control/v1/box/net/ospf [GET]
    Returns OSPF data.

    Response

    200

    Comment JSON

    { 
      "neighbours": [ 
        {
          "interface": { 
            "name": "", 
            "address": "" 
          },
          "name": "", 
          "prio": 1, 
          "state": "", 
          "deadTime": 1, 
          "address": "" 
        }
      ],
      "interfaces": [ 
        {
          "status": [
            "" 
          ],
          "name": "" 
        }
      ]
    }
  • /rest/control/v1/box/net/bgp [GET]
    Returns BGP data.

    Response

    200

    Comment JSON

    { 
      "neighbours": [ 
        {
          "ip": "", 
          "as": 1, 
          "receivedMessages": 1, 
          "sentMessages": 1, 
          "upDownTime": 1, 
          "prefixesReceived": 1 
        }
      ],
      "prefixes": [ 
        {
          "network": { 
            "address": "", 
            "mask": 1 
          },
          "path": [
            "" 
          ],
          "nextHop": "", 
          "metric": 1, 
          "localPref": "", 
          "weight": 1, 
          "origin": "" 
        }
      ],
      "as": 1 
    }


  • /rest/control/v1/box/net/rip [GET]
    Returns RIP data.

    Response

    200

    Comment JSON

    { 
      "networks": [ 
        {
          "network": { 
            "address": "", 
            "mask": 1 
          },
          "nextHop": "", 
          "metric": 1, 
          "fromVia": "", 
          "tag": "", 
          "validTime": 1 
        }
      ],
      "status": [
        "" 
      ]
    }


License operative data

  • /rest/control/v1/box/licenses [GET]
    Returns the state of active licenses on the NextGen Firewall.

    Response

    200

    Comment JSON

    { 
      "licenses": [ // List of licenses
        {
          "state": "ok", // State of the license
          // Possible values are:
          // * "unknown" - Unknown
          // * "ok" - OK
          // * "warning" - Warning
          // * "error" - Error
          "module": "base-bnvf500", // Module this license is for
          "license": "00000123-BN-VF500-1234", // License name
          "hostId": "CPU-1234-5678-0000-0000-0000-0000", // Host ID this license is bound to
          "status": "Valid-Host-ID", // Status of the license
          "expires": 1893456000 // Timestamp of license expiry
        }
      ]
    }


  • /rest/control/v1/box/licensevalues [GET]
    Returns the license values.

  • /rest/control/v1/box/versions [GET]
    Returns the version status of the NextGen Firewall.

    Response

    200

    Comment JSON

    { 
      "entries": [ // List of module entries
        {
          "state": "ok", // Module state
          // Possible values are:
          // * "unknown" - Unknown
          // * "ok" - OK
          // * "warning" - Warning
          // * "error" - Error
          "module": "NGFirewall-OS", // Module name
          "type": "package", // Module type
          "version": "phionnet_release-10.0.0-142.noarch", // Module version
          "comment": "GWAY-10.0.0-142", // Module comment
          "status": "Valid-Host-ID" // Module status
        }
      ]
    }


  • /rest/control/v1/box/hostids [GET]
    Returns the license host IDs.
  • /rest/control/v1/box/securitysubscriptions [GET]
    Returns the security subscription.

    Response

    200

    Comment JSON

    { 
      "subscriptions": [ // List of security subscriptions
        {
          "attributes": [ // List of additional attributes (subscription dependent)
            {
              "name": "DB Version", // Attribute name
              "value": "4.764" // Attribute value
            }
          ],
          "name": "AppID", // Subscription name
          "description": "Application Control 2.0", // Subscription description
          "state": "ok", // Subscription state
          // Possible values are:
          // * "unknown" - Unknown
          // * "ok" - OK
          // * "warning" - Warning
          // * "error" - Error
          "status": "Licensed (Energize Update)", // Subscription status
          "lastUpdate": 1461143002, // Timestamp of last update
          "expires": 1893456000 // Timestamp of expiry
        }
      ]
    }


Administrative Session Data

  • /rest/control/v1/box/sessions [GET]
    Returns all sessions that are active on the NextGen Firewall.

    Response

    200

    Comment JSON

    { 
      "sessions": [ // Session list
        {
          "type": "serverService", // Session type
          // Possible values are:
          // * "boxService" - Box service
          // * "serverService" - Server service
          // * "shell" - Shell access
          "pid": 11438, // Process ID
          "name": "firewall_NGFW", // Process name
          "peer": "10.0.0.1:12345", // Peer address
          "start": 4766, // Time ago the session was started (s)
          "idle": 2992, // Time the session has been idle (s)
          "admin": "root" // User name of the administrator
        }
      ]
    }


Firewall Data

URL Parameters
Name Type Example Description
forward boolean true Filter for forwarded connections
loopback boolean false Filter for loopback connections
localIn boolean true Filter for local terminating connections
localOut boolean true Filter for local originating connections
ipv4 boolean true Filter for IPv4 connections
ipv6 boolean true Filter for IPv6 connections
closing boolean true Filter for closing connections
established boolean true Filter for established connections
failing boolean true Filter for failing connections
pending boolean true Filter for pending connections
source string 10.0.0.1 Filter for source IP address
sourceDestination string 10.0.0.1 Filter for source or destination IP address
destination string 10.0.0.1 Filter for destination IP address
port string 80 Filter for port
dev string eth0 Filter for device
reverseDev string eth0 Filter for reverse device
forwardDev string eth0 Filter for forward device
rule string MGMT-ACCESS Filter for rule name
protocol number 6 Filter for (numeric) IP protocol (TCP = 6, UDP = 17)
realm number - -
protocol string HTTP* Filter for protocol name
application string Web* Filter for application name
target string www.barracuda.com Filter for application target/context
content string - -
user string root Filter for user name
sourceGeo string - -
destinationGeo string - -
urlCategory string * Filter for URL category
idleTime number 60 Filter for idle time (s)
full boolean false Request overview or full data
geo boolean false Request geographic data
count number 1000 Number of results to return

 

  • /rest/firewall/v1/live [GET]
    Returns all live connections.

    Request

    ?full=false

    Response

    200

    Comment JSON

    { 
      "traffic": { // Traffic statistics
        "forward": { // Forwarded traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "local": { // Local traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "loopback": { // Loopback traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        }
      },
      "connections": [ // Listing of live connections
        {
          "source": { // Source address
            "ip": "10.0.0.1", // IP Address
            "port": 80 // Port
          },
          "destination": { // Destination address
            "ip": "10.0.0.1", // IP Address
            "port": 80 // Port
          },
          "forward": { // Forward interface
            "interface": "eth0", // Interface name
            "bytes": 1266 // Bytes transfered
          },
          "reverse": { // Reverse interface
            "interface": "eth0", // Interface name
            "bytes": 1266 // Bytes transfered
          },
          "index": 1, // ID of connection
          "activeTtid": 1, // Active TI index
          "user": "root", // User name
          "state": "established", // State of the connection
          // Possible values are:
          // * "initiate" - Connection is being initiated
          // * "established" - Connection is established
          // * "fail" - Connection is failing
          // * "closing" - Connection is closing
          "status": "LOC-EST", // Connection status
          "ruleName": "MGMT-ACCESS", // Rule name
          "type": "LIN", // Type of the connection (LB, LIN, LOUT, FWD)
          "appName": "", 
          "ipProtocol": "TCP", // IP protocol name
          "protocol": "NGF-MGMT", // Protocol (service) name
          "application": "Web browsing", // Application name
          "target": "www.barracuda.com", // Application target/context
          "speed": 6992, // Connection speed (Bytes/s)
          "idleTime": 405 // Time the connection has been idle (s)
        }
      ],
      "limited": true, // True if the output has been truncated
      "total": 1234 // Number of total connections
    }


    Request

    ?full=true

    Response

    200

    Comment JSON

    { 
      "traffic": { // Traffic statistics
        "forward": { // Forwarded traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "local": { // Local traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "loopback": { // Loopback traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "band0": { // Band 0 traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "band1": { // Band 1 traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "band2": { // Band 2 traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "band3": { // Band 3 traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "band4": { // Band 4 traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "band5": { // Band 5 traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "band6": { // Band 6 traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        },
        "band7": { // Band 7 traffic
          "bps": 123456, // Bytes per second
          "packets": 47 // Packets per second
        }
      },
      "connections": [ // Listing of live connections
        {
          "source": { // Connection source
            "geo": { // Geographic data
              "shortName": "AT", // Short country name
              "fullName": "Austria", // Long country name
              "region": "Europe-EU" // Region name
            },
            "nat": { // NAT address
              "ip": "10.0.0.1", // IP Address
              "port": 80 // Port
            },
            "quarantineType": "", 
            "ip": "10.0.0.1", // IP Address
            "port": 80 // Port
          },
          "destination": { // Connection destination
            "geo": { // Geographic data
              "shortName": "AT", // Short country name
              "fullName": "Austria", // Long country name
              "region": "Europe-EU" // Region name
            },
            "nat": { // NAT address
              "ip": "10.0.0.1", // IP Address
              "port": 80 // Port
            },
            "quarantineType": "", 
            "ip": "10.0.0.1", // IP Address
            "port": 80 // Port
          },
          "forward": { // Forward interface
            "shapeConnector": "Internet", // QoS Band
            "ingressShapeConnector": "eth0", // Inbound interface
            "outgressShapeConnector": "eth0", // Outbound interface
            "interface": "eth0", // Interface name
            "bytes": 1266 // Bytes transfered
          },
          "reverse": { // Reverse interface
            "shapeConnector": "Internet", // QoS Band
            "ingressShapeConnector": "eth0", // Inbound interface
            "outgressShapeConnector": "eth0", // Outbound interface
            "interface": "eth0", // Interface name
            "bytes": 1266 // Bytes transfered
          },
          "urlCategories": [ // List of URL categories
            "" 
          ],
          "configureTtid": 1, // Configured TI index
          "evaluatedOnReverse": true, 
          "protocolId": 1, 
          "applicationId": 1, 
          "contentId": 1, 
          "vpnRoute": 1, 
          "agentId": 1, 
          "content": "", 
          "startTime": 51, // Time ago the connection started (s)
          "index": 1, // ID of connection
          "activeTtid": 1, // Active TI index
          "user": "root", // User name
          "state": "established", // State of the connection
          // Possible values are:
          // * "initiate" - Connection is being initiated
          // * "established" - Connection is established
          // * "fail" - Connection is failing
          // * "closing" - Connection is closing
          "status": "LOC-EST", // Connection status
          "ruleName": "MGMT-ACCESS", // Rule name
          "type": "LIN", // Type of the connection (LB, LIN, LOUT, FWD)
          "appName": "", 
          "ipProtocol": "TCP", // IP protocol name
          "protocol": "NGF-MGMT", // Protocol (service) name
          "application": "Web browsing", // Application name
          "target": "www.barracuda.com", // Application target/context
          "speed": 6992, // Connection speed (Bytes/s)
          "idleTime": 405 // Time the connection has been idle (s)
        }
      ],
      "limited": true, // True if the output has been truncated
      "total": 1234 // Number of total connections
    }
  • /rest/firewall/v1/history [GET]
    Returns the connection history.

    Request

    ?full=false

    Response

    200

    Comment JSON

    { 
      "connections": [ // List of connections
        {
          "source": { // Connection source
            "ip": "10.0.0.1", // IP address
            "dev": "eth0" // Interface name
          },
          "destination": { // Connection destination
            "ip": "10.0.0.1", // IP address
            "port": 80, // Port
            "dev": "eth0" // Interface name
          },
          "index": 1, // ID of the connection
          "type": "ruleBlock", // Type of the entry
          // Possible values are:
          // * "access" - Connection allowed
          // * "fail" - Connection failed
          // * "ruleBlock" - Blocked by rule
          // * "packetDrop" - Packet drop
          // * "arp" - ARP
          // * "scan" - Scan
          // * "term" - Term
          // * "web" - Web
          "reasonId": 1, 
          "reasonParam1": 1, 
          "reasonParam2": 1, 
          "count": 25, // Number of time this entry matched
          "lastTime": 4, // Time ago this entry last matched (s)
          "ruleName": "LAN-2-LAN", // Rule name
          "ipProtocol": "TCP", // IP protocol name
          "user": "root", // User name
          "nextHop": "10.0.0.1", // IP address of next hop
          "reasonText": "Block Broadcast" // Reason for the entry
        }
      ]
    }


    Request

    ?full=true

    Response

    200

    Comment JSON

    { 
      "connections": [ // List of connections
        {
          "source": { // Connection source
            "geo": { // Geographic data
              "shortName": "AT", // Short country name
              "fullName": "Austria", // Long country name
              "region": "Europe-EU" // Region name
            },
            "ip": "10.0.0.1", // IP address
            "name": "", // Name
            "mac": "11:22:33:44:55:66", // MAC address
            "dev": "eth0" // Interface name
          },
          "destination": { // Connection destination
            "geo": { // Geographic data
              "shortName": "AT", // Short country name
              "fullName": "Austria", // Long country name
              "region": "Europe-EU" // Region name
            },
            "ip": "10.0.0.1", // IP address
            "name": "", // Name
            "port": 80, // Port
            "dev": "eth0" // Interface name
          },
          "origin": "LIN", // Origin of the connection (LB, LIN, LOUT, FWD)
          "bindIp": "10.0.0.1", // Local IP address
          "connectionIp": "1.2.3.4", // Remote IP address
          "routeType": "unicast", // Route type
          "protocol": "TCP", // IP protocol name
          "protocolId": 1, 
          "application": "Web browsing", // Application name
          "applicationId": 1, 
          "target": "www.barracuda.com", // Application target/context
          "urlCategory": "", // URL category
          "index": 1, // ID of the connection
          "type": "ruleBlock", // Type of the entry
          // Possible values are:
          // * "access" - Connection allowed
          // * "fail" - Connection failed
          // * "ruleBlock" - Blocked by rule
          // * "packetDrop" - Packet drop
          // * "arp" - ARP
          // * "scan" - Scan
          // * "term" - Term
          // * "web" - Web
          "reasonId": 1, 
          "reasonParam1": 1, 
          "reasonParam2": 1, 
          "count": 25, // Number of time this entry matched
          "lastTime": 4, // Time ago this entry last matched (s)
          "ruleName": "LAN-2-LAN", // Rule name
          "ipProtocol": "TCP", // IP protocol name
          "user": "root", // User name
          "nextHop": "10.0.0.1", // IP address of next hop
          "reasonText": "Block Broadcast" // Reason for the entry
        }
      ]
    }


 Firewall Custom External Objects

  • /rest/firewall/v1/objects/networks/dynamic/externals/{id} [GET]
    Returns the list of IP addresses in this custom external object.

    Response

    200

    Comment JSON

    { 
      "ips": [ // List of IP addresses
        "10.0.0.1", 
        "10.0.0.2" 
      ]
    }


  • /rest/firewall/v1/objects/networks/dynamic/externals/{id} [POST]
    Adds one or more IP addresses to this custom external object.

    Request

    Append

    Comment JSON

    { 
      "ips": [ // List of IP addresses
        "10.0.0.1", 
        "10.0.0.2" 
      ]
    }
  • /rest/firewall/v1/objects/networks/dynamic/externals/{id} [PUT]
    Sets the list of IP addresses in this custom external object.

    Request

    Replace

    Comment JSON

    { 
      "ips": [ // List of IP addresses
        "10.0.0.1", 
        "10.0.0.2" 
      ]
    }
  • /rest/firewall/v1/objects/networks/dynamic/externals/{id} [DELETE]
    Removes all IP addresses from this custom external object.

  • /rest/firewall/v1/objects/networks/dynamic/externals/{id}/{ip} [PUT]
    Replaces one IP address in this custom external object.

    Request

    Replace

    Comment JSON

    { 
      "ip": "10.0.0.1" // IP Address
    }


  • /rest/firewall/v1/objects/networks/dynamic/externals/{id}/{ip} [DELETE]
    Removes one IP address from this custom external object.

 Firewall Network Objects

  • /rest/firewall/v1/objects/networks [GET]
    Returns the list of network object names in a virtual server. 

    Response

    200

    Comment JSON

    { 
      "objects": [ // List of network object names
        "MyNetObject1", 
        "Internet" 
      ]
    }


  • /rest/firewall/v1/objects/networks [POST]
    Creates a new network object in a virtual server.

    Request

    Append

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "overrideSharedObject": true, // Override object if it already exists and is a shared object
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    201

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/objects/networks/{name} [DELETE]
    Removes a specific network object in a virtual server.

  • /rest/firewall/v1/objects/networks/{name} [GET]
    Returns the network object details in a virtual server.

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/objects/networks/{name} [PUT]
    Replaces the network object in a virtual server.

    Request

    Replace

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/objects/networks/{name}/{list} [POST]
    Adds an entry to the network object in a virtual server.

    Response

    200

    Comment JSON

    { 
      "type": , // Type of network entry.
      "ipV4": "192.168.1.1", // IPv4 Address
      "rangeV4": "192.168.1.1-5", // IPv4 Range
      "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
      "reference": "Internet", // Network Object reference name.
      "comment": "DNS Server 1", // Comment about the network entry.
      "mac": "ee:97:65:11:f7:8d", // MAC address
      "device": "eth0" // Network interface
    }


  • /rest/firewall/v1/objects/networks/{name}/{list}/{entry} [DELETE]
    Removes a specific entry from a network object.

  • /rest/firewall/v1/servers/{server}/services/{service}/objects/networks [GET]
    Returns the list of network objects in a specific service.

    Response

    200

    Comment JSON

    { 
      "objects": [ // List of network object names
        "MyNetObject1", 
        "Internet" 
      ]
    }


  • /rest/firewall/v1/servers/{server}/services/{service}/objects/networks [POST]
    Creates a new network object in a specific service.

    Request

    Append

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "overrideSharedObject": true, // Override object if it already exists and is a shared object
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    201

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/servers/{server}/services/{service}/objects/networks/{name} [DELETE]
    Removes a specific network object from a specific service.

  • /rest/firewall/v1/servers/{server}/services/{service}/objects/networks/{name} [GET]
    Returns the network object details in a specific service.

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/servers/{server}/services/{service}/objects/networks/{name} [PUT]
    Replaces a network object in a specific service.

    Request

    Replace

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/servers/{server}/services/{service}/objects/networks/{name}/{list} [POST]
    Adds an entry to a network object in a specific service.

    Request

    Append

    Comment JSON

    { 
      "type": , // Type of network entry.
      "ipV4": "192.168.1.1", // IPv4 Address
      "rangeV4": "192.168.1.1-5", // IPv4 Range
      "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
      "reference": "Internet", // Network Object reference name.
      "comment": "DNS Server 1", // Comment about the network entry.
      "mac": "ee:97:65:11:f7:8d", // MAC address
      "device": "eth0" // Network interface
    }


  • /rest/firewall/v1/servers/{server}/services/{service}/objects/networks/{name}/{list}/{entry} [DELETE]
    Removes a specific entry from a network object in a specific service.

  • /rest/firewall/v1/cc/global/objects/networks [GET]
    Returns the list of global network objects.

    Response

    200

    Comment JSON

    { 
      "objects": [ // List of network object names
        "MyNetObject1", 
        "Internet" 
      ]
    }


  • /rest/firewall/v1/cc/global/objects/networks [POST]
    Creates a new global network object.

    Request

    Append

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "overrideSharedObject": true, // Override object if it already exists and is a shared object
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    201

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/global/objects/networks/{name} [DELETE]
    Removes a specific global network object.

  • /rest/firewall/v1/cc/global/objects/networks/{name} [GET]
    Returns global network object details.

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/global/objects/networks/{name} [PUT]
    Replaces a global network object.

    Request

    Replace

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    201

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/global/objects/networks/{name}/{list} [POST]
    Adds an entry to a global network object.

    Response

    200

    Comment JSON

    { 
      "type": , // Type of network entry.
      "ipV4": "192.168.1.1", // IPv4 Address
      "rangeV4": "192.168.1.1-5", // IPv4 Range
      "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
      "reference": "Internet", // Network Object reference name.
      "comment": "DNS Server 1", // Comment about the network entry.
      "mac": "ee:97:65:11:f7:8d", // MAC address
      "device": "eth0" // Network interface
    }


  • /rest/firewall/v1/cc/global/objects/networks/{name}/{list}/{entry} [DELETE]
    Removes a specific entry from a global network object.

  • /rest/firewall/v1/cc/ranges/{range}/objects/networks [GET]
    Returns the list of network objects in a range.

    Response

    200

    Comment JSON

    { 
      "objects": [ // List of network object names
        "MyNetObject1", 
        "Internet" 
      ]
    }


  • /rest/firewall/v1/cc/ranges/{range}/objects/networks [POST]
    Creates a new network object in a range.

    Request

    Append

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "overrideSharedObject": true, // Override object if it already exists and is a shared object
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    201

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/objects/networks/{name} [DELETE]
    Removes a specific network object in a range.

  • /rest/firewall/v1/cc/ranges/{range}/objects/networks/{name} [GET]
    Returns network object details in a range.

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/objects/networks/{name} [PUT]
    Replaces a network object in a range.

    Request

    Replace

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/objects/networks/{name}/{list} [POST]
    Adds an entry to a network object in a range.

    Response

    Request

    Comment JSON

    { 
      "type": , // Type of network entry.
      "ipV4": "192.168.1.1", // IPv4 Address
      "rangeV4": "192.168.1.1-5", // IPv4 Range
      "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
      "reference": "Internet", // Network Object reference name.
      "comment": "DNS Server 1", // Comment about the network entry.
      "mac": "ee:97:65:11:f7:8d", // MAC address
      "device": "eth0" // Network interface
    }


  • /rest/firewall/v1/cc/ranges/{range}/objects/networks/{name}/{list}/{entry} [DELETE]
    Removes a specific entry from a network object in a range.

  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/objects/networks [GET]
    Returns the list of network objects in a cluster.

    Response

    200

    Comment JSON

    { 
      "objects": [ // List of network object names
        "MyNetObject1", 
        "Internet" 
      ]
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/objects/networks [POST]
    Creates a new network object in a cluster.

    Request

    Append

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "overrideSharedObject": true, // Override object if it already exists and is a shared object
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    } 

    Response

    201

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/objects/networks/{name} [DELETE]
    Removes a specific network object from a cluster.

  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/objects/networks/{name} [GET]
    Returns network object details in a cluster.

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/objects/networks/{name} [PUT]
    Replaces a network object in a cluster.

    Request

    Replace

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/objects/networks/{name}/{list} [POST]
    Adds an entry to a network object in a cluster.

    Response

    200

    Comment JSON

    { 
      "type": , // Type of network entry.
      "ipV4": "192.168.1.1", // IPv4 Address
      "rangeV4": "192.168.1.1-5", // IPv4 Range
      "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
      "reference": "Internet", // Network Object reference name.
      "comment": "DNS Server 1", // Comment about the network entry.
      "mac": "ee:97:65:11:f7:8d", // MAC address
      "device": "eth0" // Network interface
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/objects/networks/{name}/{list}/{entry} [DELETE]
    Removes a specific entry from a network object in a cluster.

  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/objects/networks [GET]
    Returns the list of network objects in a specific service.

    Response

    200

    Comment JSON

    { 
      "objects": [ // List of network object names
        "MyNetObject1", 
        "Internet" 
      ]
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/objects/networks [POST]
    Creates a new network object in a specific service.

    Request

    Append

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "overrideSharedObject": true, // Override object if it already exists and is a shared object
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    201

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/objects/networks/{name} [DELETE]
    Removes a specific network object from a specific service.

  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/objects/networks/{name} [GET]
    Returns network object details in a specific service.

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/objects/networks/{name} [PUT]
    Replaces network object in a specific service.

    Request

    Replace

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    201

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/objects/networks/{name}/{list} [POST]
    Adds an entry to a network object in a specific service.

    Request

    Append

    Comment JSON

    { 
      "type": , // Type of network entry.
      "ipV4": "192.168.1.1", // IPv4 Address
      "rangeV4": "192.168.1.1-5", // IPv4 Range
      "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
      "reference": "Internet", // Network Object reference name.
      "comment": "DNS Server 1", // Comment about the network entry.
      "mac": "ee:97:65:11:f7:8d", // MAC address
      "device": "eth0" // Network interface
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/objects/networks/{name}/{list}/{entry} [DELETE]
    Removes a specific entry from a network object in a specific service.

  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/boxes/{box}/objects/networks [GET]
    Returns the list of network objects on a managed firewall.

    Response

    200

    Comment JSON

    { 
      "objects": [ // List of network object names
        "MyNetObject1", 
        "Internet" 
      ]
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/boxes/{box}/objects/networks [POST]
    Creates a new network object on a managed firewall.

    Request

    Append

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "overrideSharedObject": true, // Override object if it already exists and is a shared object
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    201

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/boxes/{box}/objects/networks/{name} [DELETE]
    Removes a specific network object from a managed firewall.

  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/boxes/{box}/objects/networks/{name} [GET]
    Returns network object details on a managed firewall.

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/boxes/{box}/objects/networks/{name} [PUT]
    Replaces network object on a managed firewall.

    Request

    Replace

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/boxes/{box}/objects/networks/{name}/{list} [POST]
    Adds an entry to a network object on a managed firewall.

    Response

    200

    Comment JSON

    { 
      "type": , // Type of network entry.
      "ipV4": "192.168.1.1", // IPv4 Address
      "rangeV4": "192.168.1.1-5", // IPv4 Range
      "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
      "reference": "Internet", // Network Object reference name.
      "comment": "DNS Server 1", // Comment about the network entry.
      "mac": "ee:97:65:11:f7:8d", // MAC address
      "device": "eth0" // Network interface
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/boxes/{box}/objects/networks/{name}/{list}/{entry} [DELETE]
    Removes a specific entry from a network object on a managed firewall. 

  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/{shared}/objects/networks [GET]
    Returns the list of network objects on a shared service.

    Response

    200

    Comment JSON

    { 
      "objects": [ // List of network object names
        "MyNetObject1", 
        "Internet" 
      ]
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/{shared}/objects/networks [POST]
    Creates a new network object for a shared service.

    Request

    Append

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "overrideSharedObject": true, // Override object if it already exists and is a shared object
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }  


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/{shared}/objects/networks/{name} [DELETE]
    Removes a specific network object from a shared service.

  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/{shared}/objects/networks/{name} [GET]
    Returns network object details for a shared service.

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/{shared}/objects/networks/{name} [PUT]
    Replaces network object on a shared service.

    Request

    Replace

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }

    Response

    200

    Comment JSON

    { 
      "included": [ // List of network entries associated with this network object. These will match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "excluded": [ // List of network entries associated with this network object. These will prevent a match.
        {
          "type": , // Type of network entry.
          "ipV4": "192.168.1.1", // IPv4 Address
          "rangeV4": "192.168.1.1-5", // IPv4 Range
          "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
          "reference": "Internet", // Network Object reference name.
          "comment": "DNS Server 1", // Comment about the network entry.
          "mac": "ee:97:65:11:f7:8d", // MAC address
          "device": "eth0" // Network interface
        }
      ],
      "name": "MyNetObject1", // Name of the network object
      "type": , // Type of the network object
      "comment": "DNS Servers" // Comment about the network object.
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/{shared}/objects/networks/{name}/{list} [POST]
    Adds an entry to a network object in a shared service.

    Response

    200

    Comment JSON

    { 
      "type": , // Type of network entry.
      "ipV4": "192.168.1.1", // IPv4 Address
      "rangeV4": "192.168.1.1-5", // IPv4 Range
      "ipV6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", // IPv6 Address
      "reference": "Internet", // Network Object reference name.
      "comment": "DNS Server 1", // Comment about the network entry.
      "mac": "ee:97:65:11:f7:8d", // MAC address
      "device": "eth0" // Network interface
    }


  • /rest/firewall/v1/cc/ranges/{range}/clusters/{cluster}/servers/{server}/services/{service}/{shared}/objects/networks/{name}/{list}/{entry} [DELETE]
    Removes a specific entry from a network object in a shared service.

Last updated on