Retrieve a mapping between FQDNs and network objects

Returns a mapping between FQDNs and network objects. For every FQDN sent, a list of matching network objects is returned.

Resource name: /api/v1/networkObject/search/byFqdns

Request method: POST

Request parameters:

Parameter Type Description

deviceName

mandatory

string

Tree name of the device.

(To get the entity name for a device or group, see Device names in the ASMS APIs

fqdns

mandatory

array of strings List of FQDNs.

useDeviceGroup

mandatory

boolean

Determines whether the response includes only applications configured for the group, or globally, or also includes applications specifically configured for the device.

  • true: Response includes only applications configured for the group, or globally. (default)

  • false: response also includes applications specifically configured for the device.

Request example: 

{
	"deviceName": "example_device",
	"fqdns": [
		"www.google.com",
		"www.yahoo.com",
		"www.facebook.com"
				],
	"useDeviceGroup": true
}

cUrl Example: 

curl -X POST "https://<localhost>/api/v1/networkObject/search/byFqdns" -H "Content-Type: application/json" -d '{"deviceName": "example_device", "fqdns": ["www.google.com", "www.yahoo.com", "www.facebook.com"], "useDeviceGroup": true}'

Status codes:

Code Description
200 OK
400 Bad Request

Response parameters:

Parameter Type Description
canonizedName string Canonical name of the network object.
classname string Class name of the network object.
fqdnObjects array List of FQDN objects associated with the network object.
id integer Unique identifier of the FQDN object.
name string Name of the FQDN object.
icon string Icon associated with the network object.
id integer ID of the network object.
invalidNamedObject boolean Indicates if the named object is invalid.
ipCount integer IP count of the network object.
ipType string Type of IP (Null, IPv4, IPv6, or mixed).
ipaddress string IP address of the network object.
members string Members of the network object.
natRanges array List of NAT ranges associated with the network object.
natType string Type of NAT (NONE, NAT, STATIC, or HIDE).
objectContainer object Object container associated with the network object.
brand object Brand associated with the object container.
containerId string Identifier of the container.
id integer Unique identifier of the object container.
managementDevice string Management device associated with the object container.
name string Name of the object container.
originalName string Original name of the object container.
objectInternalType object Object internal type associated with the network object.
id integer Unique identifier of the object internal type.
name string Name of the object internal type.
originalName string Original name of the network object.
user string User associated with the network object.
zone string Zone associated with the network object.

Response example success 200: 

{
  "example_network_object": [
    {
      "canonizedName": "www.google.com",
      "classname": "NetworkObject",
      "fqdnObjects": [
        {
          "id": 1,
          "name": "www.google.com"
        }
      ],
      "icon": "google_icon",
      "id": 123,
      "invalidNamedObject": false,
      "ipCount": 1,
      "ipType": "IPv4",
      "ipaddress": "8.8.8.8",
      "members": "",
      "natRanges": [],
  "natType": "NONE",
  "objectContainer": {
    "brand": {
      "id": 10,
      "name": "Example Brand"
    },
    "containerId": "container_1",
    "id": 100,
    "managementDevice": "device_1",
    "name": "Example Container",
    "originalName": "Example_Container"
  },
  "objectInternalType": {
    "id": 20,
    "name": "Example Internal Type"
  },
  "originalName": "www.google.com",
  "user": "example_user",
  "zone": "example_zone"
}
   ]
}

Response example failure 400: 

{
  "error": "Invalid request",
  "message": "Device name is not provided."
}