Retrieve interfaces

Retrieve the interfaces of a device or a group/matrix of devices, along with their IP addresses.

Note: This request requires permission for All_Firewalls.

Resource Name:

/api/v1/interfaces

Controller: Network Interfaces External Controller

Request Method: GET

Request URL Parameters:

Element

Type

Description
entity Mandatory

String

The display name of the device, group, or matrix.
entityType Optional

String

One of the following:

  • FIREWALL (default)

  • GROUP
  • MATRIX

Note: The page and size elements are not supported for the get_interfaces request.

Response:

Element

Type

Description
name

String

The entity name.
type

String

The entity type.
interfaces

A list of interface objects.

A list of interface information. See Interface Type (see Interface Type ).
status

String

One of the following:

  • true. Indicates the request succeeded.
  • false. Indicates the request failed.
message Only is returned when the request fails.

String

An error message.

Request example

curl -H "Content-Type: application/json" -k 'https://127.0.0.1/fa/server/interfaces/read?session=1cb3ec62e5db893f960130070d54900a&entityType=firewall&entity=Immacolata'

Response example

{

"0": {

"name": Immacolata",

"type":"DEVICE",

"interfaces":[

{"hwName":"eth5",

"ip":"10.60.32.0\/30",

"id":"293",

"zoneType":"INTERNAL",

"ipsBehindInterface":"10.60.32.0 - 10.60.32.3,26.26.26.0 - 26.26.26.255"},

{"hwName":"eth0",

"ip":"10.20.0.0\/16",

"id":"295",

"zoneType":"INTERNAL",

"ipsBehindInterface":"0.0.0.0 - 10.10.2.255,10.10.4.0 - 10.20.32.0,10.20.32.2 - 10.30.31.255,10.30.32.4 - 10.40.2.255,10.40.4.0 - 10.50.2.255,10.50.4.0 - 10.60.31.255,10.60.32.4 - 10.110.2.255,10.110.4.0 - 10.120.2.255,10.120.4.0 - 20.20.19.255,20.20.21.0 - 26.26.25.255,26.26.27.0 - 255.255.255.255"},

]

},

"status": true

}