Get a list of devices and policy details

Gets a list of all devices that the user has permissions to view. For a single device, use the device parameter.

Resource Name:

/api/v1/allowedDevices/

Request Method: GET

Request Query Parameters:

Element

Type

Description

domain

Mandatory

Integer

Domain ID. Always use default value: 0
includeBlueCoat
optional 		Boolean

Determines whether the response should include Symantec Blue Coat devices:

  • yes: Include Blue Coat devices.

  • no: (default) Exclude Blue Coat devices.
onlyFireflowSupportedDevices
optional 		Boolean

Determines whether the response should include only FireFlow-supported devices:

  • yes: (default) Include only FireFlow-supported devices.

  • no: Include also FireFlow unsupported devices.

treeName

optional

String

A name for the device that includes an aggregated string of the device's name and the name of any parent or grandparent devices.

This name is not displayed in the ASMS UI. It must be returned from the database by API. Use the Devices Setup Resource Group (use the "name" parameter in the response):

Since this name includes the tree hierarchy, it is used as the unique system device.

Response:

Code

Description
200

OK. Returns the requested data as specified in JSON format.

400

Bad request

401

Unauthorized

Request example 

curl -X GET "https://<localhost>/afa/api/v1/allowedDevices?domain=0&includeBlueCoat=no&onlyFireflowSupportedDevices=yes&deviceTreeName=10_20_244_3_HR1" -H "accept: */*"

Response example 

[
  {
    "id": 35600,
    "treeName": "10_20_244_3_HR1",
    "displayName": "ACI3_HR1",
    "policy": "HR1",
    "deviceIp": "10.20.244.3",
    "lastReport": "afa-5854",
    "lastReportRun": "afa-5854",
    "lastReportTime": "2021-07-07-040000",
    "lastMonitorStatus": "Success",
    "monitorDir": "/home/afa/algosec/monitor/10_20_244_3/HR1",
    "modified": 1629304514,
    "creationTime": 1609428091606,
    "isLayer2": true,
    "layer2Subnet": "",
    "isDeviceWithNatRules": false,
    "isDeviceWithIPv6": false,
    "isGenericActiveChange": false,
    "isCKPApplicationControl": false,
    "lastReportProfile": "Perimeter.xml",
    "commentSupported": "IRRELEVANT",
    "brandDisplayName": "Cisco ACI",
    "type": "firewall",
    "deviceLicenseId": "10_20_244_3_HR1",
    "lastCompletedReportLicenseId": "0e9b2dd5",
    "deviceExtendedInfo": {
      "policyNameForFireflow": "",
      "genericDeviceFeatures": [
        "config_diff",
        "data_collection_from_file",
        "changes_network_objects",
        "topology",
        "active_change",
        "rules",
        "first_step_data_collection",
        "skip_config_collection",
        "change_history",
        "disable_forcing_layer2_query",
        "source_based_routing",
        "queries",
        "data_collection",
        "risks",
        "regulatory_compliance",
        "parser",
        "changes_services",
        "model_cloud_topology",
        "full",
        "disable_placing_layer2_on_map"
      ],
      "superName": "10_20_244_3",
      "superDisplayName": "ACI3",
      "objectContainers": [
        "10_20_244_3_HR1"
      ],
      "deviceIdForRuleDocDB": "10_20_244_3_HR1",
      "deviceUseOpsec": false,
      "deviceWithActiveChange": false,
      "deviceWithGenericActiveChange": true,
      "deviceSupportedByFireflow": true,
      "deviceWithIPv6AndIPV4Mix": false,
      "brandForFireflow": "Cisco ACI",
      "displayNameForFireflow": "ACI3_HR1",
      "domainId": 0,
      "userDefinedGroup": false,
      "matrix": false,
      "singleFirewall": true,
      "groupTypeForFireflow": "firewall",
      "deviceWithPostNatDestinationRule": false,
      "applicationSupported": false,
      "globalRulesSupport": false,
      "lastMonitorTime": "2021-08-18-123513",
      "rulesFormat": "CPL",
      "supportLayeredRules": false,
      "properties": {
        "mso_managed": "true"
      },
      "logForwardingProfiles": "",
      "securityProfileGroups": ""
    },
    "ruleDocDevices": [
      21400
    ],
    "ruleDocDevicesFromDB": [
      {
        "id": 21400,
        "name": "10_20_244_3_HR1",
        "brand": {
          "id": 19,
          "name": "ciscoaci"
        }
      }
    ],
    "name": "10_20_244_3_HR1",
    "reserved": false,
    "deleted": false
  },
  {
    "id": 24651,
    "treeName": "Daisy_Azure_australiaeast_AustraliaFinance",
    "lastReport": "Daisy_Azure_australiaeast_A...