Retrieve interfaces

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

The input will be the active session ID and the name of a device, group, or matrix. The output will be a list of all the interfaces of all the devices in the selected group and 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

vrfName Optional

String

For Cisco ACI only:

Name of the VRF network.

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 -X GET --cookie "PHPSESSID=vo3v7r76ldbh13rh61e4v5aeer" http://localhost:8000/afa/api/v1/interfaces?entity=ckp77

Response example 

{
  "name": "ckp77",
  "type": "DEVICE",
  "interfaces": [
    {
      "hwName": "eth0",
      "ip": "10.20.75.1/16",
      "id": "19",
      "zoneType": "EXTERNAL",
      "ipsBehindInterface": "0.0.0.0 - 10.10.74.255,10.10.76.0 - 10.30.74.255,10.30.76.0 - 10.40.74.255,10.40.76.0 - 10.50.74.255,10.50.76.0 - 10.110.74.255,10.110.76.0 - 10.120.74.255,10.120.76.0 - 255.255.255.255",
      "logicalName": "if_5"
    },
    {
      "hwName": "eth1",
      "ip": "10.10.75.1/24",
      "id": "20",
      "zoneType": "INTERNAL",
      "ipsBehindInterface": "10.10.75.0 - 10.10.75.255",
      "logicalName": "if_4"
    },
    {
      "hwName": "eth2",
      "ip": "10.30.75.1/24",
      "id": "21",
      "zoneType": "INTERNAL",
      "ipsBehindInterface": "10.30.75.0 - 10.30.75.255",
      "logicalName": "if_3"
    },
    {
      "hwName": "eth3",
      "ip": "10.40.75.1/24",
      "id": "22",
      "zoneType": "INTERNAL",
      "ipsBehindInterface": "10.40.75.0 - 10.40.75.255",
      "logicalName": "if_2"
    },
    {
      "hwName": "eth4",
      "ip": "10.50.75.1/24",
      "id": "23",
      "zoneType": "INTERNAL",
      "ipsBehindInterface": "10.50.75.0 - 10.50.75.255",
      "logicalName": "if_1"
    },
    {
      "hwName": "eth5",
      "ip": "10.110.75.1/24",
      "id": "24",
      "zoneType": "INTERNAL",
      "ipsBehindInterface": "10.110.75.0 - 10.110.75.255",
      "logicalName": "if_0"
    },
    {
      "hwName": "eth6",
      "ip": "10.120.75.1/24",
      "id": "25",
      "zoneType": "INTERNAL",
      "ipsBehindInterface": "10.120.75.0 - 10.120.75.255",
      "logicalName": "if_6"
    }
  ]
}