Get device info about managed devices

Gets information on devices managed by the specified management device.

Note: For example, you may want to use these APIs to get values for parameters when adding new management devices to AFA, or editing management device configurations. For more details, see Add/Edit a device.

Resource Name:

Brand

URL

Cisco Firepower, Cisco Meraki, Palo Alto Panorama, Juniper Space,

/api/v1/devices/managedDevices/genericDevices

(shows all devices that the user has permissions to view)

Fortinet Fortimanager

/api/v1/devices/managedDevices/fortimanager

(shows all devices that the user has permissions to view)

Check Point Smart Center

/api/v1/devices/managedDevices/cma

Check Point Provider 1

/api/v1/devices/managedDevices/pv1

(shows all devices that the user has permissions to view)

Check Point Provider 1/Check Point Smart Center

/api/v1/devices/managedDevices/pv1/cma

(shows all devices that the user has permissions to view)

Request Method: POST

Request URL Parameters:

For Brand

Element

Type

Description

Cisco Firepower, Cisco Meraki, Palo Alto Panorama,
Juniper Space

 body String

JSON that specifies the management device that manages the generic devices for which you want to get details. Actual parameters to use vary per brand. in the following format:

{
  "authenticationKey": "string",
  "brandName": "string",
  "collector": "string",
  "getCompleteHierarchy": true,
  "hostname": "string",
  "password": "string",
  "username": "string"
}

In the body request JSON, for:

  • authenticationKey. Add the authentication key,

  • brandName use the following brand name codes:

    Brand Brand Name Code
    Palo Alto Panorama panorama
    Cisco FirePower firepower
    Juniper Space space_security_director
    Cisco Meraki ciscomeraki

  • Collector: Specify where the device is added: Central Manager (default) or Remote Agent name (for example, RA81)

  • getCompleteHierarchy: For Panorama and Juniper Space Director:
    Boolean. Set the amount of detail provided in the response

    • true (default): returns the complete hierarchy of the device (must be the top device in the hierarchy (level 1)), direct child devices (level 2) and grandchildren (level 3), and great-grandchildren (level 4)

    • false: returns narrower details of the device (must be the top device in the hierarchy (level 1)) and direct child devices (level 2))

Fortinet Fortimanager,

Check Point Smart Center, Check Point Provider 1

body

String

A map of devices in the following syntax:

map<String, Object>

Response:

Brand

Description

Cisco Firepower, Cisco Meraki, Palo Alto Panorama,
Juniper Space

JSON that specifies the management device that manages the devices for which you want to get details.

Fortinet Fortimanager,

Check Point Smart Center, Check Point Smart Center, Check Point Provider 1

A map of devices in the following syntax:

map<String, Object>

.

Code

Description
200

OK

400

Bad request

401

Unauthorized

403

Non-admin user

Request examples (genericDevices) 

{
  "MS_host_name": "10.20.0.1",
  "CKP_R80_or_higher": "no",
  "MS_user_name": "myUser",
  "MS_passwd": "myPassword",
  "MS_epasswd": "myExpertPassword",
  "FW_TYPE": "PV1"
}

{
  "brandName": "space_security_director",
  "hostname": "10.20.283.1",
  "username": "admin",
  "password": "algosec1",
  "getCompleteHierarchy": true
}

Request example (Fortimanager) 

curl --insecure "https://localhost/afa/api/v1/devices/managedDevices/fortimanager" --request POST \
  -H "Content-Type: application/json" \
  -H "Cookie: PHPSESSID=et52j33f796dl86pt7ms7efq29" \
  -d '{"brand":"fortimanager","user_name": "fmgr_admin","host_name":"10.20.40.100","passwd":"algosec","rest_port":"3443"}'

Response example (genericDevices) 

  "message": "OK",
  "status": true,
  "device": {
    "host_name": "10.20.283.1",
    "node_type": "FW_MGMT",
    "name": "10.20.283.1",
    "sub_devices": [
      {
        "host_name": "yellow_New",
        "node_type": "FW_GEN",
        "device_domain": "2",
        "name": "Lion_New_t1",
        "original_name": "Lion_New_t1",
        "display_name": "Lion_New_t1",
        "sub_devices": [
          {
            "host_name": "1.2.9.3",
            "node_type": "FW_VIRT",
            "device_domain": "2",
            "name": "root",
            "original_name": "root",
            "display_name": "root",
            "sub_devices": [
              {
                "host_name": "1.2.9.3",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "default",
                "original_name": "default",
                "display_name": "default",
                "device_level": 4
              },
              {
                "host_name": "1.2.9.3",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "ask_test",
                "original_name": "ask_test",
                "display_name": "ask_test",
                "device_level": 4
              }
            ],
            "device_UID": "22222",
            "device_level": 3,
            "device_id": "2"
          },
          {
            "host_name": "1.2.9.3",
            "node_type": "FW_VIRT",
            "device_domain": "2",
            "name": "Test_root",
            "original_name": "Test_root",
            "display_name": "Test_root",
            "sub_devices": [
              {
                "host_name": "1.2.9.3",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "default",
                "original_name": "default",
                "display_name": "default",
                "device_level": 4
              }
            ],
            "device_UID": "22222",
            "device_level": 3,
            "device_id": "3"
          },
          {
            "host_name": "1.2.9.3",
            "node_type": "FW_VIRT",
            "device_domain": "32769",
            "name": "ls-Management",
            "original_name": "ls-Management",
            "display_name": "ls-Management",
            "sub_devices": [
              {
                "host_name": "10.20.95.1",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "default",
                "original_name": "default",
                "display_name": "default",
                "device_level": 4
              }
            ],
            "device_UID": "222222",
            "device_level": 3,
            "device_id": "5"
          },
          {
            "host_name": "1.2.9.3",
            "node_type": "FW_VIRT",
            "device_domain": "32769",
            "name": "ls-Quality-Assurance",
            "original_name": "ls-Quality-Assurance",
            "display_name": "ls-Quality-Assurance",
            "sub_devices": [
              {
                "host_name": "10.20.95.1",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "default",
                "original_name": "default",
                "display_name": "default",
                "device_level": 4
              },
              {
                "host_name": "1.2.9.3",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "QA-vr1",
                "original_name": "QA-vr1",
                "display_name": "QA-vr1",
                "device_level": 4
              }
            ],
            "device_UID": "33333",
            "device_level": 3,
            "device_id": "6"
          },
          {
            "host_name": "1.2.9.3",
            "node_type": "FW_VIRT",
            "device_domain": "32770",
            "name": "ls-Research-And-Development",
            "original_name": "ls-Research-And-Development",
            "display_name": "ls-Research-And-Development",
            "sub_devices": [
              {
                "host_name": 1.2.9.3",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "default",
                "original_name": "default",
                "display_name": "default",
                "device_level": 4
              },
              {
                "host_name": "10.20.95.1",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "Testing_with_Meirit",
                "original_name": "Testing_with_Meirit",
                "display_name": "Testing_with_Meirit",
                "device_level": 4
              },
              {
                "host_name": "1.2.9.3",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "rnd-vr1",
                "original_name": "rnd-vr1",
                "display_name": "rnd-vr1",
                "device_level": 4
              }
            ],
            "device_UID": "33333",
            "device_level": 3,
            "device_id": "7"
          },
          {
            "host_name": "1.2.9.3",
            "node_type": "FW_VIRT",
            "device_domain": "2",
            "name": "secure_wire",
            "original_name": "secure_wire",
            "display_name": "secure_wire",
            "sub_devices": [
              {
                "host_name": "1.2.9.3",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "default",
                "original_name": "default",
                "display_name": "default",
                "device_level": 4
              }
            ],
            "device_UID": "33333",
            "device_level": 3,
            "device_id": "8"
          }
        ],
        "device_UID": "33333",
        "device_level": 2,
        "syslogIdentifiers": [
          "10.0.1.1",
          "10.0.1.2",
          "10.0.1.3",
          "10.0.1.4",
          "10.10.11.10",
          "10.110.95.1",
          "10.12.1.2",
          "10.14.95.1",
          "10.140.95.1",
          "10.20.10.10",
          "10.20.30.40",
          "10.20.95.1",
          "10.30.95.1",
          "10.40.95.1",
          "10.60.95.1",
          "10.70.95.1",
          "100.5.100.254",
          "13.1.1.1",
          "14.1.1.1",
          "14.168.168.1",
          "172.172.0.254",
          "192.168.168.1",
          "25.0.0.1",
          "34.10.0.254",
          "67.68.254.254",
          "94.1.0.254",
          "BH3313AJ0033",
          "Lion_New_t1",
          "Test_root",
          "ls-Management",
          "ls-Quality-Assurance",
          "ls-Research-And-Development",
          "root",
          "secure_wire"
        ],
        "serial_num": "BH3313AJ0033",
        "device_id": "2"
      },
      {
        "host_name": "Uranus",
        "node_type": "FW_GEN",
        "device_domain": "32768",
        "name": "vSRX-Uranus",
        "original_name": "Uranus",
        "display_name": "Uranus",
        "sub_devices": [
          {
            "host_name": "1.2.9.3",
            "node_type": "FW_VIRT",
            "device_domain": "32768",
            "name": "root",
            "original_name": "root",
            "display_name": "root",
            "sub_devices": [
              {
                "host_name": "1.2.9.3",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "default",
                "original_name": "default",
                "display_name": "default",
                "device_level": 4
              },
              {
                "host_name": "1.2.9.3",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "Router1",
                "original_name": "Router1",
                "display_name": "Router1",
                "device_level": 4
              },
              {
                "host_name": "1.2.9.3",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "VR.1",
                "original_name": "VR.1",
                "display_name": "VR.1",
                "device_level": 4
              },
              {
                "host_name": "1.2.9.3",
                "device_type": "virtual-router",
                "node_type": "GEN_VR",
                "name": "auto_VR",
                "original_name": "auto_VR",
                "display_name": "auto_VR",
                "device_level": 4
              }
            ],
            "device_UID": "2222",
            "device_level": 3,
            "device_id": "32769"
          }
        ],
        "device_UID": "2222",
        "device_level": 2,
        "syslogIdentifiers": [
          "10.20.146.34",
          "10.40.95.2",
          "11.0.0.253",
          "176.16.1.16",
          "193.1.0.1",
          "198.0.0.254",
          "696C1B22C915",
          "vSRX-Uranus"
        ],
        "serial_num": "696C1B22C915",
        "device_id": "32769"
      }
    ],
    "device_level": 1
  },
  "displayLevel": "2"

Response example (Fortimanager) 

{
    "map": {
      "FWName": "root",
      "FWOrigName": "root",
      "FW_display_name": "root",
      "FWParent": "farid-1"
    }
  },
  {
    "map": {
      "FWName": "new-5",
      "FWOrigName": "new-5",
      "FW_display_name": "new-5",
      "FWParent": "farid-1"
    }
  },
  {
    "map": {
      "FWName": "VDOM",
      "FWOrigName": "VDOM",
      "FW_display_name": "VDOM",
      "FWParent": "farid-1"
    }
  },
  {
    "map": {
      "FWName": "krmv_root",
      "FWOrigName": "root",
      "FW_display_name": "krmv_root",
      "FWParent": "krmv"
    }
  },
  {
    "map": {
      "FWName": "1_HA",
      "FWOrigName": "1_HA",
      "FW_display_name": "1_HA",
      "FWParent": "krmv"
    }
  },
  {
    "map": {
      "FWName": "2_HA",
      "FWOrigName": "2_HA",
      "FW_display_name": "2_HA",
      "FWParent": "krmv"
    }
  }
]